Recognized Keywords

grdoc recognizes several keywords. You may use additional keywords if you wish, but this will produce a warning from the grdoc system, and be added in the additional information section of the grdoc documentation output.

The keywords fall into three classes. Keywords which can and cannot be contained, and container keywords. Note a special class of keywords which can be contained, the @v* keywords, must be contained in a @var region.

Keywords which cannot be contained

Comments:
KeywordIntended Meaning
@fileThe name of file in question
@headerThe header file in question
@routineThe name of the routine in question
@versionThe author-assigned version number. Note the RCS ID, if present, will also be placed in the documentation
@authorThe author of the routine/file in question
@dateThe date the routine was last modified
@definesThe macros defined in the routine/file/header
@includsThe files included in the current file
@calledbyThe nameof the @routine which calls the current @routine
@callsThe name of the @routines which are called by the current @routine
@stencilThe size, in computational elements, of the stencil used by the routine in question
@returntypeThe type of object the routine or function returns. If the routine is void (or a fortran subroutine) omit this keyword.

Keywords which may or must be contained

Comments:
@seefileCreates a cross reference to the file mentioned as specified either by file name or by @file
@seeroutineCreates a cross reference to the routine mentioned specified only by @routine
@seeheaderCreates a cross reference to the header mentioned specified only by @header
@seeclass See info on grdoc with OO Langs
@seestruct See info on grdoc with OO Langs
@seepackage See info on grdoc with OO Langs
@vdescA short description of a variable
@vtypeThe type (eg, float, int *) of variable
@vioThe i/o of the variable. Choose in, out, inout, or local, commonblock, or global
@vcommentAn unrestrained comment. NOTE this tag MAY contain html
@pdescA short description of a parameter
@ptypeThe type (eg, float, int *) of the parameter
@pvaluesPossible values for the parameter in question
@pcommentAn unrestrained comment. NOTE this tag MAY contain html
@hdateThe date of the change
@hauthorThe author of the change
@hddescThe description of the change

Boolean Keywords

@treeentryThe routine should be marked as a possible entry point into the calling tree
@public
@private
@protected
See info on grdoc with OO Langs

Container Keywords

@desc ...
@enddesc
A description of the item in question
@comment ...
@endcomment
A comment
@var ...
@endvar
Description of a variable. Note the optional information to this container tag is the name of the variable in question.
@par ...
@endpar
Description of a parameter Note the name of the optional information is the name of the parameter used by the routine in question.
@history ...
@endhistory
List of historical changes to the file/routine/header in question.
@returndesc ...
@endreturndesc
A description of the thing the subroutine returns, if it has a returntype. Note using @returndesc without @returntype will have unpredicatble results at best...
@method ...
@endmethod
See info on grdoc with OO Langs