Note 2: For JavaDoc compatibility a # may be used instead of a :: in the patterns above. Note 1: The patterns above should not contain spaces, tabs or newlines. Links to functions are created if one of the following patterns is encountered:
If the word is indeed the name of a documented input file, a link will automatically be created to the documentation of that file. ) that is not the last character in the word are considered to be file names. If you want to prevent that a word that corresponds to a documented class is replaced by a link you should put a % in front of the word.Īll words that contain a dot (.
#Doxygen generate pdf how to
The next sections show how to generate links to the various documented entities in a source file.ĭoxygen will automatically replace any URLs and mail addresses found in the documentation by links (in HTML).Īll words in the documentation that correspond to a documented class will automatically be replaced by a link to the page containing the documentation of the class. For man pages no reference information is generated. Furthermore, the index at the end of the document can be used to quickly find the documentation of a member, class, namespace or file. For documentation a reference to the page number is written instead of a link. Although doxygen also has a command to start such a section (See section \sa), it does allow you to put these kind of links anywhere in the documentation.
Doxygen manual: Automatic link generation Automatic link generationMost documentation systems have special `see also' sections where links to other pieces of documentation can be inserted.
0 kommentar(er)
