![]() ![]() \sa Inside a see also section any word is checked, so EType, Links to the destructor are: #~Test and ~Test().Ī link to a member in this class: member().Ī link to a variable \link #var using another text\endlink as a link.Ī link to some enumeration values: \link Test::Val1 Val1 \endlink and ::GVal1.Īnd last but not least a link to a file: autolink.cpp. Two ways to link to a constructor are: #Test and Test(). Since this documentation block belongs to the class Test no link to Test::member(int) and Test#member(int,int)Ī link to a protected member variable of Test: Test#var,Ī link to the global enumeration type #GlobEnum.Ī link to the destructor of the Test class: Test::~Test,Ī link to the enumeration type Test::ETypeĪ link to some enumeration values Test::Val1 and ::GVal2 More specific links to the each of the overloaded members: For sake of clarity it is advised to only use patterns 3 and 6 in this case.Ī link to a member of the Test class: Test::member, ![]() Links to variables, typedefs, enum types, enum values and defines.Īll of these entities can be linked to in the same way as described in the previous section. The class that corresponds to the documentation blocks that contains the pattern has a base class that contains a documented member that matches the pattern. The pattern points to a documented member that belongs to the same class as the documentation block that contains the pattern. pattern 2 or 5 is used), a link will be created to the documentation of one of the overloaded members.įor member functions the class scope (as used in patterns 4 to 6) may be omitted, if: If a function is overloaded and no matching argument list is specified (i.e. Note 3: In the documentation of a class containing a member foo, a reference to a global variable is made using ::foo, whereas #foo will link to the member.įor non overloaded members the argument list may be omitted. 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 (. 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 Comments
Leave a Reply. |