The K Desktop Environment

A.2. Common tags

@li <text>

A list item.

@internal

Mark member as internal to the library and not for external use.

@deprecated

Marks member as obsolete.

@version <string>

Provide version information about the member. I normally set this to the RCS/CVS ID tag.

@author <string>

Specify the author.

@since <string>

Specify the version of the API in which this member was added.

@sect <string>

A section heading, for grouping your doc comment logically.

<pre> text </pre>

A block of literal (preformatted) text, useful for code examples.

@image <path>

Embed an image in the output. This can be set to a URL, but it is better to use a path if possible since this will allow the image to be included in other formats in the future.

@see <ref>,...

Links to related information.

@ref <ref>

Like @see, but inline, so it can be used within a text paragraph. Also, only one member can be referenced at a time, so you will have to include multiple @ref tags for multiple members.