![]() ![]() Qt Software's GUI toolkit Qt version 5.14 or higher (including Qt 6). To take full advantage of doxygen's features the following additional tools should be installed. In order to generate a Makefile for your platform, you need cmake version 3.14 or later. You need python (version 2.7 or higher, see ). The GNU tools flex, bison, libiconv and GNU make If you downloaded the source distribution, you need at least the following to build the executable: For sake of clarity it is advised to only use patterns 3 and 7 in this case.First go to the download page to get the latest distribution, if you have not downloaded doxygen already. 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.Īll of these entities can be linked to in the same way as described in the previous section. The pattern points to a documented member that belongs to the same class as the documentation block that contains the pattern. pattern 2 or 6 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 7) may be omitted, if: If a function is overloaded and no matching argument list is specified (i.e. Note 4: 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 3: For Javadoc compatibility a # may be used instead of a :: in the patterns above. 'func(int) const' and 'func(int)' target different member functions. Note 2: Member function modifiers (like 'const' and 'volatile') are required to identify the target, i.e. 'fun(const std::string&,bool)' or '()' to match any prototype. Note 1: Function arguments should be specified with correct types, i.e. 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. To link to an all lower case symbol, use \ref.Īll words that contain a dot (. 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. Which will be automatically translated to other output formats by doxygen.Īll words in the documentation that correspond to a documented class and contain at least one non-lower case character will automatically be replaced by a link to the page containing the documentation of the class. To manually specify link text, use the HTML ' a' tag: link text 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). 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. Most documentation systems have special ‘see also’ sections where links to other pieces of documentation can be inserted.
0 Comments
Leave a Reply. |
Details
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |