Tools: HeaderDoc Unfettered: Multiword Names

## Multiword Names

Top-level HeaderDoc tags, such as `@header` and `@function` can take multiword names. This is particularly useful for documenting anonymous types for enumerations, for example. However, HeaderDoc normally has no way to know whether a line containing multiple words is a multiword name or a name followed by a discussion.

There are two ways to get a multiword name. One way is to add a discussion tag, like this:

Listing 2-1 Example of multiword names using @discussion

     /*!
| `
`
     * @enum example enum
| `
`
     * @discussion This is a test, this is only a test.
| `
`
     *
| `
`
     * Because we included an \@discussion tag, the name of the enum is
| `
`
     * “example enum”.
| `
`
     */
| `
`

The other way is to simply add a line break after the name.

Listing 2-2 Example of multiword names using multiple lines

     /*!
| `
`
     * @enum example enum
| `
`
     * This is a test, this is only a test.
| `
`
     *
| `
`
     * Because the discussion contains multiple lines, the name of the enum is
| `
`
     * “example enum”.
| `
`
     */
| `
`

© 1999, 2004 Apple Computer, Inc. All Rights Reserved. (Last updated: 2004-05-27)