SupportedTags

Michalis Kamburelis edited this page Jan 7, 2017 · 7 revisions
Clone this wiki locally

You can use tags inside the comments to have PasDoc automatically add some information or have it treat some text in a special manner. A tag is always prefixed with the "@" character. Some tags require an argument which must be enclosed in braces (see also TagsParametersWithoutParenthesis), others do not, see TagsParameters.

Alphabetical list of supported tags:

@@

Insert the @ character literally

@abstract

Specify a short abstract of the description

@anchor

Set up an invisible anchor inside introduction/conclusion

@author

Specify an author’s name (and email address etc.)

@bold

Format text using bold font

@br

Force line break

@cell

Create a cell in a table

@classname

Insert the class name

@code

Format argument as code example (see also @longCode)

@created

Specify creation date of this item

@cvs

Obtain last modification time or author name from cvs $Date and $Author keywords

@definitionList

Create definition list

@deprecated

Mark this item as deprecated

@exclude

Exclude this item from documentation @false::Insert the specially formatted text "false"

@html

Insert the direct HTML code into HTML output

@image

Include image file

@include

Include description from file

@includeCode

Include Pascal code (like a longer code example) from file

@inherited

Insert the name of the ancestor class or member

@inheritedClass

Insert the name of the ancestor class

@italic

Format text using italic font

@item

Make list item

@itemLabel

Define a label for next item within definition list

@itemSetNumber

Change the number of next item inside ordered list

@itemSpacing

Control the vertical spacing between items of a list

@lastmod

Specify last modification date of this item

@latex

Insert direct LaTeX code into LaTeX output

@link

Insert a link to another item

@longcode

Format argument as multiline Pascal code example (see also @code)

@member

Specify description for a member (field, method, property) of a structure in description of this structure

@name

Insert the name of this item

@nil

Insert the specially formatted text "nil" here

@noAutoLink

Inside parameter of this tag auto-linking is never used

@noAutoLinkHere

Never auto-link to this item

@orderedList

Create ordered list

@param

Describe the parameter of this method (or procedure/function)

@preformatted

Insert text using fixed-width font and preserving whitespace

@raises

Describe the exception which may be raised by this method

@return, @returns

Describe function’s return value

@row

Create a row in a table

@rowHead

Create a heading row in a table

@section

Start new section inside introduction/conclusion

@seealso

Create "See also" section for given item

@shorttitle

Short title of introduction/conclusion

@table

Create a table

@tableOfContents

Insert table of contents into introduction/conclusion

@title

Title of introduction/conclusion

@true

Insert the specially formatted text "true"

@unorderedList

Create unordered list

@value

Description for enumerated value in description of it’s enumerated type

Some other special @-constructs:

@-

Insert short dash. Usually you can simply write "-", no need to precede it with "@", but in some special cases it’s needed if you want to avoid creating en-dash or em-dash in the output. See WritingDocumentation for notes about en-dashes and em-dashes.

@(

Insert the opening parenthesis character. Usually you can simply write "(", no need to precede it with "@", but in some special cases it’s needed --- see TagsParametersMatching.

@)

Insert the closing parenthesis character. Usually you can simply write ")", no need to precede it with "@", but in some special cases it’s needed --- see TagsParametersMatching.