w3hello.com logo
Home PHP C# C++ Android Java Javascript Python IOS SQL HTML videos Categories
What are the new documentation commands available in Xcode 5?

Here is an example of all the options I have found as of Xcode 5.0.2

enter image
description here

That was generated with this code:

/** First line text.

 Putting \n doesn't create a new line.
 One way to create a newline is by making sure nothing is on that line. Not
even a single space character!

 @a Italic text @em with @@a or @@em.

 @b Bold text with @@b.

 @p Typewritter font @c with @@p or @@c.

 Backslashes and must be escaped: C:\foo.

 And so do @@ signs: user@@example.com

 Some more text.
 @brief brief text
 @attention attention text
 @author author text
 @bug bug text
 @copyright copyright text
 @date date text
 @invariant invariant text
 @note note text
 @post post text
 @pre pre text
 @remarks remarks text
 @sa sa text
 @see see text
 @since since text
 @todo todo text
 @version version text
 @warning warning text

 @result result text
 @return return text
 @returns returns text


 @code
// code text
while (someCondition) {
    NSLog(@"Hello");
    doSomething();
}@endcode
 Last line text.

 @param param param text
 @tparam tparam tparam text
 */
- (void)myMethod {}

Notes:

  • The commands must be in a /** block */, /*! block */, or prefixed with /// or //!.
  • The commands work with the @ (headerdoc style) or the (doxygen style) prefix. (I.e. @b and  both do the same thing.)
  • The commands usually come before the item they are describing. (I.e. if you are trying to document a property, the comment must come before the @property text.) They can come afterwards, on the same line, with /*!<, /**<, //!<, ///<.
  • You can add documentation to classes, functions, properties, and variables.
  • All of these commands appear in dark green text to signify that they are valid commands, except for @returns.
  • You may need to build your project (or restart Xcode) before the latest changes to your documentation appear.

Where to see the documentation:

1. During code complete, you will see the brief text:

enter image
description here

This will show the brief text (with no formatting); if no brief text exists, it will show a concatenation of all the text up to the first @block; if none exists (e.g. you begin with @return), then it will concat all the text striping away all @commands.

2. Option-clicking an identifier name:

enter image
description here

3. In the Quick Help Inspector panel

(See first screenshot.)

4. In Doxygen

Since the commands in Xcode 5 are compatible with Doxygen, you could download and use Doxygen to generate documentation files.

Other Notes

For a general introduction to Doxygen and how to document Objective-C code, this page seems like a good resource.

Descriptions of some of the supported commands:

  • @brief: will insert text at the beginning of the description field, and is the only text that will appear during code completion.

The following don't work:

  • : doesn't generate a newline. One way to create a newline is by making sure nothing is on that line. Not even a single space character!
  • example

The following are not supported (they don't even appear in dark green):

  • cite
  • docbookonly
  • enddocbookonly
  • endinternal
  • endrtfonly
  • endsecreflist
  • idlexcept
  • mscfile
  • efitem
  • elatedalso
  • tfonly
  • secreflist
  • short
  • snippet
  • ableofcontents
  • vhdlflow
  • ~
  • "
  • .
  • ::
  • |

Apple reserved keywords:

Apple uses what appears to be reserved keywords that only works in their documentation. Although they appear in dark green, it looks like we cannot use them as Apple does. You can see examples of Apple's usage in files such as AVCaptureOutput.h.

Here is a list of some of those keywords:

  • @abstract, @availibility, @class, @discussion, @deprecated, @method, @property, @protocol, @related, @ref.

At best, the keyword will cause a new line in the Description field (e.g. @discussion). At worst, the keyword and any text following it will not appear in the quick help (e.g. @class).





© Copyright 2018 w3hello.com Publishing Limited. All rights reserved.