Cross referencing
Home | Packages | Files | Procedures | Classes | Keywords | External packages
As said in the last page about available commands the
documentation is allowed to contain cross references to other packages, files,
classes, procedures and external entities. Here I describe the reference
format recognized by engine.
This interface was changed in the transition from version 1.0 to 2.0. Please
read the change report too.
- All cross references are of the form: <key argument>.
Possible keys are
Key | Short key |
---|
arg | a |
class | c |
ext | e |
file | f |
img | i |
method | m |
option | o |
pkg | |
proc | p |
variable | v |
xref | x |
- arg
- Reference to a procedure argument. Never a hyperlink.
- class
- Reference to a class. Argument is the referred name.
- ext
- Reference to an external 'required' package. Argument is the name of the
package. Formatted as hyperlink if additional information about the named
package was given separately (See integration page,
'depDef').
- file
- Reference to a file. Argument is the referred path,
relative to the source directory of the distribution.
- img
- Reference to an image. Argument is the code of the image, as it was
registered via distribution:imgDef. The referenced image is
inserted into the documentation at the place of the reference.
- method
- Reference to a method of a class. The argument contains
both class and method name, in the form 'class:method'.
- option
- Reference to an option of a class. The argument contains
both class and option name, in the form 'class:option'.
- pkg
- Reference to a package defined in the distribution.
Argument is the referred name.
- proc
- Reference to a procedure. Argument is the referred name.
- variable
- Reference to a variable of a class. The argument contains
both class and variable name, in the form 'class:variable'.
- xref
- Reference of an external hyperlink. Argument is the internal symbolic name
of the link, as defined via distribution:xrefDef.
The crossreference commands 'method', 'option' and 'variable'
allow the usage of a short form without a classname prefix.
Such references will automatically use the class the reference
is in as the class of the refered entity.
Another recognized command is &p. It is not a cross
reference, but allows the introduction of paragraph breaks.
Next
Generated by AutoDoc 2.1 at 02/15/1999, invoked by Andreas Kupries