The table below lists the NaturalDocs syntax that DVT recognizes. For more details see
http://www.naturaldocs.org.
NaturalDocs Links
An in-line link in a comment can be created using
<LINK_ADDRESS LINK_TEXT>.There are two types of links:
Internal Links -> point to data inside Documentation. In this case
LINK_ADDRESS must respect the following notation:
Package_Name::Class_Name.Method_Name for an absolute path or
TYPE_NAME.INNER_TYPE_NAME or just
TYPE_NAME for relative paths. In case of a relative path a link will be created to the best match for that type with regard to its scope inside the project.
NOTE: Using relative paths could generate broken links if there are different data types with the same name inside the project!
External Links -> point to external web pages or files. For webpages
LinkAddress must start with
http:// and for files with
file:// followed by the resource's address. For example: <
https://www.dvteclipse.com> or <file://external-res.pdf>
For both types of links
LINK_TEXT is optional and it can be used to show a user defined text instead of link's path.
|