diff options
Diffstat (limited to 'doc/autolink.doc')
| -rw-r--r-- | doc/autolink.doc | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/autolink.doc b/doc/autolink.doc index 94b28d4..c7f9ba7 100644 --- a/doc/autolink.doc +++ b/doc/autolink.doc @@ -30,12 +30,12 @@ The next sections show how to generate links to the various documented entities in a source file. - \subsection linkurl Links to web pages and mail addresses + \section linkurl Links to web pages and mail addresses Doxygen will automatically replace any URLs and mail addresses found in the documentation by links (in HTML). - \subsection linkclass Links to classes. + \section linkclass Links to classes. All words in the documentation that correspond to a documented class will automatically be replaced by a link to the page containing the @@ -43,14 +43,14 @@ that corresponds to a documented class is replaced by a link you should put a \% in front of the word. - \subsection linkfile Links to files. + \section linkfile Links to files. All words that contain a dot (<tt>.</tt>) that is not the last character in the word are considered to be file names. If the word is indeed the name of a documented input file, a link will automatically be created to the documentation of that file. - \subsection linkfunc Links to functions. + \section linkfunc Links to functions. Links to functions are created if one of the following patterns is encountered: @@ -90,7 +90,7 @@ that matches the pattern. </ol> - \subsection linkother Links to variables, typedefs, enum types, enum values and defines. + \section linkother Links to variables, typedefs, enum types, enum values and defines. All of these entities can be linked to in the same way as described in the previous section. For sake of clarity it is advised to only use @@ -103,7 +103,7 @@ for the corresponding HTML documentation that is generated by Doxygen. \endhtmlonly - \subsection resolving typedefs. + \section resolving typedefs. Typedefs that involve classes, structs and unions, like \verbatim |