6.2.1 Extracting Information

  To extract the information the source code is parsed for TAC definition comments, containing either documentation or language binding definitions. A TAC comment has the form shown in Table 6.3 where t is the optional TAC binding character `T', only for language binding required, and c the documentation definition character.

  
Tabelle 6.3: Special comments for TAC

For reference documentation extraction the optional t is ignored and only the documentation character is used. F90 is handled identical to FORTRAN so no F90 extensions are recognized. For language binding only comments containing the t are scanned and for these definitions the extracted information is saved for the second step of the language binding. The case insensitive documentation characters shown in Table 6.4 are supported depending on the source domain of the file. A warning is given, if a specific documentation character is not supported.

  
Tabelle 6.4: TAC documentation characters

The entries marked in the column TAC may be used for language binding from source domain to target domain if the associated character is support for the source language.

Special information about the documented part can be given directly at the beginning of the comment using one or more key values between [ and ] brackets. The following general keywords are recognized:

:section documentation CEFMTV
Override documentation default output section.

:reference documentation CEFMTV
Create a reference to following names in the documentation.

:title documentation M
Combine multiple macros under one title. In this case the number of macros is specified directly after the `M'.

:local documentation CEFMTV
Documentation is only local to project.

:element documentation C
Constant is part of an element group with the given name.

:type documentation C
The constant is of the given type. This is important especially if the type of the constant cannot be determined automatically for language binding from its definition.

:c-name documentation FC
Use this function name for a C target domain. Required key if a language binding from FORTRAN to C is wanted.

:fortran-name documentation FC
Use this function name for a FORTRAN target domain. Required key if a language binding from C to FORTRAN is wanted.

:lisp-name documentation FC
Use this function name for a VLisp target domain. This overrides the default naming convention from C and C++ to VLisp.

:atom documentation X
Extract documentation in source into given documentation atom.

:isotope documentation X
Extract documentation in source into an isotope defined in the documentation description file.

 
• Parameter documentation