Home

Manual for version 1.8.0 Written by Dimitri van Heesch ©1997-2012

1. 20 17 SHORT_ZNAMES 00 000000 ee 20 2 UML LOOK oa ar eee eee A 20 17 SHOW_DIRECTORIES 20 3 USE_LHTAGS 20 6 SHOW IFILES ic 44 a ke a de 20 3 USE_INLINE_TREES ooo 20 8 SHOW_INCLUDE_FILES 20 3 USE MATHJAX ooo 20 8 SHOW_NAMESPACES 0 0 20 3 USE PDFLATEX ooo 20 9 SHOW_USED FILES 20 3 VERBATIM_HEADERS 20 6 SIP_SUPPORT ooo 20 2 WARN_FORMAT ooo 20 4 SKIP_FUNCTION_MACROS ooooo 20 15 WARN_IF_DOC_ERROR 20 4 SORT_BRIEF_DOCS 0 20 3 WARN_IF_UNDOCUMENTED 20 4 SORT_BY_SCOPE_NAME 20 3 WARN_LOGFILE ooo 20 4 SORT_GROUP_NAMES 0005 20 3 WARN_NO_PARAMDOC 20 4 SORT_MEMBER_DOCS 20 3 WARNINGS 00000000 eee eee 20 4 SORT_MEMBERS CTORS_1ST 20 3 XMLIDTD sco bare es aa Peery SES 20 12 SOURCE BROWSER 20 6 XML_OUTPUT Guri oe ee ede eS 20 12 STRIP_CODE_COMMENTS 20 6 XML_PROGRAMLISTING 00 20 12 STRIP_FROM_INC_PATH 20 20 2 XML_SCHEMA 000000002 20 12 20 2 Project related options DOXYFILE_ENCODING This tag specifies the encoding used for all characters in the config file that fol low The default is UTF 8 which is also the encoding used for all text before the first occurrence of this tag Doxygen uses libiconv or the iconv built into libc for the transcoding See http www gnu org software libicon
2. 20 8 INCLUDE_FILE PATTERNS 20 15 EXAMPLE PATH o 20 5 INCLUDE_GRAPH oo 20 17 EXAMPLE_PATTERNS ooo 20 5 INCLUDE_PATH 0 20 15 EXAMPLE_RECURSIVE 00 20 5 INCLUDED BY GRAPH oo 20 17 EXCLUDE 000 20 5 INHERIT_DOCS 0 00000 ce eee 20 2 EXCLUDE_PATTERNS 00000 20 5 INLINE GROUPED_CLASSES 20 2 EXCLUDE SYMBOLS 00 20 5 INLINE INFO 0 0 0 0 ee eee 20 3 EXCLUDE_SYMLINKS 0000 20 5 INLINE INHERITED_MEMB 20 2 EXPAND_AS DEFINED 20 15 INLINE SOURCES 000 20 6 EXPAND_ONLY_PREDEF 2015 INPUT 00 eee 20 5 EXT_LINKS_IN WINDOW 20 8 INPUT_ENCODING 00000004 20 5 EXTENSION MAPPING 00 20 2 INPUT_FILTER 00 ee 20 5 EXTERNAL_GROUPS 00 20 16 INTERACTIVE SVG 00000 20 17 EXTRA PACKAGES 00 000004 20 9 INTERNAL_DOCS 0000004 20 3 EXTRACTALL 2 0 0 0 000 cece eee 20 3 JAVADOC_AUTOBRIEF 000 20 2 EXTRACT ANON_NSPACES 20 3 LATEX_BATCHMODE 000 20 9 EXTRACT _LOCAL_CLASSES 20 3 LATEX_BIB_STYLE onau aaa 20 9 EXTRACT_LOCAL_METHODS 20 3 LATEX_CMD_NAME 0004 20 9 EXTRACT PRIVATE 0 000000 20 3 LATEX FOOTER o 0 00000 eee 20 9 EXTRACT STATIC 0 0 0 0 0000 eee eee 20 3 LATEX HEADER 000
3. Generated by Doxygen 122 Special Commands name refers to the file that should be included by the application to obtain the definition of the class struct or union The lt header name gt argument can be used to overwrite the name of the link that is used in the class documentation to something other than lt header file gt This can be useful if the include name is not located on the default include path like lt X11 X h gt With the lt header name gt argument you can also specify how the include statement should look like by adding either double quotes or sharp brackets around the name By default sharp brackets are used if just the name is given If a pair of double quotes is given for either the lt header file gt or lt header name gt argument the current file in which the command was found will be used but with quotes So for a comment block with a headerfile command inside a file test h the following three commands are equivalent headerfile test h test h headerfile test h headerfile To get sharp brackets you do not need to specify anything but if you want to be explicit you could use any of the following headerfile test h lt test h gt headerfile test h lt gt headerfile lt gt To globally reverse the default include representation to local includes you can set FORCE_LOCAL_INCLUDES to YES To disable the include information altogether set SHOW_INCLUDE_FILES to No 21 17 hid
4. 20 8 HTML_ALIGN_MEMBERS 20 8 QHP_CUST FILTER NAME 20 8 HTML_COLORSTYLE_GAMMA 20 8 QHP_NAMESPACE 000 20 8 HTML_COLORSTYLE_HUE 20 8 QHP_SECT_FILTER_ATTRS 0 20 8 HTML_COLORSTYLE_SAT 000 20 8 QHP_VIRTUAL_FOLDER 0 20 8 HTML_DYNAMIC_SECTIONS 20 8 QT_AUTOBRIEF Lo 20 2 HTML_EXTRA FILES 000000 20 8 QUIET Lars Cow ake he ott Bes ae td bles 20 4 HTML_FILE_EXTENSION 20 8 RECURSIVE 0 00000 0000 e ee eee eee 20 5 HTML_FOOTER 0000 cee eee 20 8 REFERENCED _BY_RELATION 20 6 HTML_HEADER 0000 ee eee 20 8 REFERENCES LINK SOURCE 20 6 Generated by Doxygen 20 2 Project related options 93 REFERENCES RELATION 20 6 STRIP_FROM_PATA ooo 20 2 REPEATZBRIEF ooo 20 2 SUBGROUPING ooo 20 2 RTF_EXTENSIONS FILE 20 10 SYMBOL_CACHE_SIZE 20 2 RTF_HYPERLINKS ooo 2000 TABUSIZE ona boo ee a ed 20 2 ATF OUTPUT os cee dd ad abe RAs gaa ded 204 TAGFILES agonia ad ed ede dk ad a 20 16 RTF_STYLESHEET FILE o ooo 20 10 TEMPLATE_RELATIONS 20 17 SEARCH_INCLUDES 200 20 15 TOC_EXPAND 00 00008 20 8 SEARCHENGINE 20 8 TREEVIEWWIDTH o 20 8 SEPARATE_MEMBER_PAGES 20 2 TYPEDEF_HIDES STRUCT 20 2 SERVER_BASED_SEARCH 20 8 UML_LIMIT NUM_FIELDS
5. o o 21 57 details detailed description o o 21 58 lelse 21 59 elseif lt section label gt 2 21 60 endcond 21 61 endif 21 62 lexception lt exception object gt exception description 2 222 o e 21 63 if lt section label gt Generated by Doxygen 8 CONTENTS 21 64 ifnot lt section label lt ci be eR a eee ee Ee 133 21 65 invariant description of invariant 2 ee 134 21 66 note Ie ea eee CE a a ae Ge Ee ee Pee a Oe eee a we eS 134 21 67 par paragraph title paragraph 2 ee 134 21 68 param dir lt parameter name gt parameter description o o o o 134 21 69 tparam lt template parameter name gt description o ooo o e 135 21 70 post description of the postcondition o lt s se ee e sea oo 135 21 71 pre description of the precondition oo 135 21 72 MAR Tromark ccs cele we ia aa A a 136 21 73 remarks rom k Iex o o occuro dara rtea a a a 136 21 74 result description of the result Value o oo a ee 136 21 75 return description of the return value oaoa a 136 21 76 returns description of the return value ooa e 136 21 77 retval lt return value gt description o o o 136 21 78 sa references ee 136 21 79 see references oo c oae e oe e a n i e ee 137 21 80 Ashort shori deschiption ea nes 506 sa
6. Ej gt Starts a piece of text displayed in an italic font lt EM gt Ends a lt EM gt section lt FORM gt Does not generate any output lt FORM gt Does not generate any output lt HR gt Writes a horizontal ruler lt H1 gt Starts an unnumbered section lt H1 gt Ends an unnumbered section lt H2 gt Starts an unnumbered subsection lt H2 gt Ends an unnumbered subsection lt H3 gt Starts an unnumbered subsubsection lt H3 gt Ends an unnumbered subsubsection lt I gt Starts a piece of text displayed in an italic font lt INPUT gt Does not generate any output lt I gt Ends a lt I gt section lt IMG gt This command is written with attributes to the HTML output only lt LI gt Starts a new list item lt LI gt Ends a list item lt META gt Does not generate any output lt MULTICOL gt ignored by doxygen lt MUTLICOL gt ignored by doxygen lt OL gt Starts a numbered item list lt OL gt Ends a numbered item list lt P gt Starts a new paragraph lt P gt Ends a paragraph lt PRE gt Starts a preformatted fragment lt PRE gt Ends a preformatted fragment lt SMALL gt Starts a section of text displayed in a smaller font lt SMALL gt Ends a lt SMALL gt section lt SPAN gt Starts an inline text fragment with a specific style HTML only lt SPAN gt Ends an inline text fragment with a specific style HTML only lt STRONG gt Starts a section
7. GVall x 1 lt global enum value 1 x Generated by Doxygen 62 Automatic link generation GVal2 x lt global enum value 2 x y x A macro definition x define ABS x x gt 0 x x typedef Test B x fn typedef Test B x A type definition 9 6 typedefs Typedefs that involve classes structs and unions like typedef struct StructName TypeName create an alias for StructName so links will be generated to StructName when either StructName itself or Type Name is encountered Example x file restypedef cpp An example of resolving typedefs x struct CoordStruct A coordinate pair struct CoordStruct x The x coordinate x float x x The y coordinate x float y y x Creates a type name for CoordStruct typedef CoordStruct Coord Ir x This function returns the addition of a cl and la c2 k el lxte2sk ol YAOI Coord add Coord cl Coord c2 i e Generated by Doxygen Chapter 10 Output Formats The following output formats are directly supported by doxygen HTML Generated if GENERAT E__HTML is set to YES i LAT TEX Generated if GENERATE_ Man pages Generated if GEN ERAT E_MAN is set to Y RTF Generated if GENERATE_RTF is set to Y n the configuration file EX is set to YES in the configuration file ES in the configu
8. More detailed enum description Generated by Doxygen 24 Documenting the code enum TEnum TVall lt enum value TVall x TVal2 lt enum value TVal2 x TVal3 lt enum value TVal3 enumPtr lt enum pointer Details x enumVar xx lt enum variable Details xx A constructor A more elaborate description of the constructor x Test xx A destructor A more elaborate description of the destructor Test xk a normal member taking two arguments and returning an integer value param a an integer argument param s a constant character pointer see Test see Test see testMeToo see publicVar return The test results int testMe int a const char s OF xk A pure virtual member x see testMe param cl the first argument param c2 the second argument virtual void testMeToo char cl char c2 0 xx x a public variable Details int publicVar xx a function variable Details int handler int a int b Similarly if one wishes the first sentence of a Qt style documentation block to automatically be treated as a brief description one may set QT_AUTOBRIEF to YES in the configuration file 3 1 1 3 Documentation at other places In the examples in the previous section the comment blocks were always located in front of the declaration or definition of a file c
9. To enable this set both SEARCHENGINE and SERVER_BASED_SEARCH to YES in the config file Advantages over the client side search engine are that it provides full text search and it scales well to large projects Disadvantages are that it does not work locally i e using a fi le URL and that it does not provide live search capabilities 3 Windows Compiled HTML Help If you are running doxygen on Windows then you can make a compiled HTML Help file chm out of the HTML files produced by doxygen This is a single file containing all HTML files and it also includes a search index There are viewers for this format on many platforms and Windows even supports it natively To enable this set GENERATE_HTMLHELP to YES in the config file To let doxygen compile the HTML Help file for you you also need to specify the path to the HTML compiler hhc exe using the HHC_LOCATION config option and the name of the resulting CHM file using CHM_FILE 66 Searching An advantage of this method is that the result is a single file that can easily be distributed It also provides full text search Disadvantages are that compiling the CHM file only works on Windows and requires Microsoft s HTML compiler which is not very actively supported by Microsoft Although the tool works fine for most people it can sometimes crash for no apparent reason how typical 4 Mac OS X Doc Sets If you are running doxygen on Mac OS X 10 5 or higher then yo
10. lt a member function protected int value lt an integer value Warning These blocks can only be used to document members and parameters They cannot be used to document files classes unions structs groups namespaces and enums themselves Furthermore the structural commands mentioned in the next section like class are not allowed inside these comment blocks 3 1 1 2 Examples Here is an example of a documented piece of C code using the Qt style A test class A more elaborate class description class Test public An enum More detailed enum description enum TEnum TVal1 lt Enum value TVall TVal2 x lt Enum value TVal2 x TVal3 lt Enum value TVal3 Enum pointer x Details x xenumPtr Enum variable x Details x enumVar Generated by Doxygen 3 1 Special comment blocks 23 A constructor x A more elaborate description of the constructor Test A destructor x A more elaborate description of the destructor Test A normal member taking two arguments and returning an integer value x param a an integer argument param s a constant character pointer return The test results sa Test Test testMeToo and publicVar int testMe int a const char s A pure virtual member LEl sa testMe param cl the first argument Xparam c2 the second argume
11. skip main until First we create a object lc t of the Test class x skipline Test Then we call the example member function x NXline example x After that our little test routine ends x line Where the example file example_test cpp looks as follows void main Test t t example Alternatively the snippet command can be used to include only a fragment of a source file For this to work the fragment has to be marked See also sections line skip skipline until and include 21 102 include lt file name gt This command can be used to include a source file as a block of code The command takes the name of an include file as an argument Source files or directories can be specified using the EXAMPLE PATH tag of doxygen s configuration file If lt file name gt itself is not unique for the set of example files specified by the EXAMPLE_PATH tag you can include part of the absolute path to disambiguate it Using the include command is equivalent to inserting the file into the documentation block and surrounding it with code and endcode commands The main purpose of the include command is to avoid code duplication in case of example blocks that consist of multiple source and header files For a line by line description of a source files use the dontinclude command in combination with the line skip skipline and until commands Alternatively the snippet command can be us
12. Groups can be nested to form a hierarchy The elements after navindex represent the layout of the different pages generated by doxygen e The class element represents the layout of all pages generated for documented classes structs unions and interfaces The namespace element represents the layout of all pages generated for documented namespaces and also Java packages e The file element represents the layout of all pages generated for documented files The group element represents the layout of all pages generated for documented groups or modules e The directory element represents the layout of all pages generated for documented directories Each XML element within one of the above page elements represents a certain piece of information Some pieces can appear in each type of page others are specific for a certain type of page Doxygen will list the pieces in the order in which they appear in the XML file The following generic elements are possible for each page briefdescription Represents the brief description on a page detaileddescription Represents the detailed description on a page authorsection Represents the author section of a page only used for man pages memberdecl Represents the quick overview of members on a page member declarations This elements has child elements per type of member list The possible child elements are not listed in detail in the document but the name of the element should be a good i
13. Here are some examples int var x lt Detailed description after the member x This block can be used to put a Qt style detailed documentation block after a member Other ways to do the same are int var lt Detailed description after the member x or int var lt Detailed description after the member lt or int var lt Detailed description after the member lt Most often one only wants to put a brief description after a member This is done as follows int var lt Brief description after the member Generated by Doxygen 22 Documenting the code or int var lt Brief description after the member For functions one can use the param command to document the parameters and then use in out in out to document the direction For inline documentation this is also possible by starting with the direc tion attribute e g void foo int v lt in docs for input parameter v Note that these blocks have the same structure and meaning as the special comment blocks in the previous section only the lt indicates that the member is located in front of the block instead of after the block Here is an example of the use of these comment blocks x A test class x class Test public An enum type The documentation block cannot be put after the enum enum EnumType int EVall lt enum value 1 x int EVal2 x lt enum value 2 x y void member
14. Manual for version 1 8 0 Written by Dimitri van Heesch 1997 2012 Contents 1 et 1 2 1 3 1 4 13 1 6 User Manual Installation Compiling from source on UNIX oa a a s e sa ma e e i a e e a a a a e e a a Installing the Binaries on UNIX o soci aon sod aaea a a ews Known compilation problems for UNIX lt gt o cosas saasa a a ee ee Compiling from source on Windows e e Installing the binaries on Windows gaca meone ma h pag a Tools used to develop doxygen 2 Getting Started 21 22 2 3 2 4 Step 0 Step 1 Step 2 2 3 1 232 2 3 3 2 3 4 2 3 5 Step 3 Check if doxygen supports your programming language Greating a configuration TS lt lt oscars Oe RA RRA Running doxygen oee e coe aok a ma de de bbe ed eee E ee ATMEOUIDOE oiiire giaa e a e E RO E a ie na a Ee A Ss LATEN OUND 0 Shoe ap a a A A A we pee oe RUFQUDIE ri Bee oh ee eee o A A ee eS PLOW Socia ee A a ae a ae de a GD Boe Bee A Manpage QUIPUL cocos a be bbe Peet hee et bbe eee dedi nes Documenting ihe SDUICES o ooe we hae a oa ER eee ee ee 3 Documenting the code 3 1 3 2 Special comment DIGCKS ss ce cae A A a ae aa Bee de A wR 3 1 1 Comment blocks for C like languages C C C Objective C PHP Java 3 1 1 1 Putting documentation after members 2 25 34 12 Examples osai e te Pee ee bee ee ee ba ee eS 3 1 1 3 Documentation atother place
15. x x defgroup group4 The Fourth Group x ingroup group3 x Group 4 is a subgroup of group 3 kx x ingroup group2 x brief class C3 in group 2 class C3 x ingroup group2 brief class C4 in group 2 class C4 x x ingroup group3 x brief class C5 in link group3 the third group endlink Class CS dt xx ingroup groupl group2 group3 group4 namespace N1 is in four groups x sa link groupl The first group endlink group2 group3 group4 Also see ref mypage2 namespace N1 xx file x ingroup group3 x brief this file in group 3 xx defgroup group5 The Fifth Group x This is the fifth group x x x page mypagel This is a section in group 5 Text of the first section x x page mypage2 This is another section in group 5 Text of the second section x x x end of group5 addtogroup groupl More documentation for the first group x f x another function in group 1 x void func2 x yet another function in group 1 void func3 xx end of groupl 5 2 Member Groups If a compound e g a class or file has many members it is often desired to group them together Doxygen already automatically groups things together on type and protection level but maybe you feel that this is not enough or that that default grouping is wrong For instance because you feel that members of different syntactic types b
16. 2 2 ee ee 117 21 5 category lt name gt lt header file gt lt header name gt nonono 000222 ee 117 21 6 class lt name gt lt header file gt lt header name gt 0 00000 eee eee 118 AUF dea oo cadera be ee RR ee ee ee 118 21 8 defgroup lt name gt group title o o 118 219 Wdir lt patitiagmente 2 2 masa tose ck mee A a aa ee 119 PLAD VER names cr A A Pe ee Ee ed 119 Pidi example lt file name gt 22 4 ano oea a a a ae 119 2112 endrtemel y ea ea a Re Re a RR ae Ye A AA 120 SUAS ERES SME he A ee ee Be ne Pes a Bae ee ee 120 AE ieee ect ee Ek Se ee See BA eS ee E eS 120 2145 Vin funci n declaration 2 2 2 0 0504 Phe eee ee a a da wd 121 21 16 headerfile lt header file gt lt header rname gt o o 121 Aide IO a oe oe pe Pa a We ee ee Da ead 122 21 18 implements lt name gt 2 yi bea ee tpa eR ee ee eee 122 21 19 ingroup lt groupname gt lt groupname gt lt groupname gt o o 122 21 20 interface lt name gt lt header file gt lt header name gt o o oo o tees 123 Slat Mila cc ee eho hod wee A ERR ES HOt EY Eb eee bee 123 21 22 Ymanpage Mite acuosa A hee ee 123 21 28 membeli lt name gt io ee ee ee PD ee we ee ee ve ee 123 Generated by Doxygen CONTENTS 21 24 name header 21 25 namespace lt nam 21 26 nosubgrouping 21 27 overload function 21 28 package lt name gt IEA pua BP Re se de Ae Ba as ee Aa a a we ey E
17. EXCLUDE_PATTERNS x test x Doxygen looks at the file s extension to determine how to parse a file using the following table Generated by Doxygen 2 3 Step 2 Running doxygen 15 Extension Language idl IDL ddl IDL odl IDL java Java cs CH da D php PHP php4 PHP php5 PHP inc PHP phtml PHP m Objective C M Objective C mm Objective C py Python f Fortran for Fortran 90 Fortran vhd VHDL vhdl VHDL tcl TCL ucf VHDL qsf VHDL md Markdown markdown Markdown Any other extension is parsed as if it is a C C file If you start using doxygen for an existing project thus without any documentation that doxygen is aware of you can still get an idea of what the structure is and how the documented result would look like To do so you must set the EXTRACT_ALL tag in the configuration file to YES Then doxygen will pretend everything in your sources is documented Please note that as a consequence warnings about undocumented members will not be generated as long as EXTRACT _ALL is set to YES To analyze an existing piece of software it is useful to cross reference a documented entity with its definition in the source files Doxygen will generate such cross references if you set the SOURCE_BROWSER tag to YES It can also include the sources directly into the d
18. For starting a section of private members in a way similar to the private class marker in C use privatesection See also sections memberof public protected and privatesection 21 31 privatesection Starting a section of private members in a way similar to the private class marker in C Indicates that the member documented in the comment block is private i e should only be accessed by other members in the same class See also sections memberof public protected and private 21 32 property qualified property name Indicates that a comment block contains documentation for a property either global or as a member of a class This command is equivalent to var typedef and fn See also sections fn typedef and var 21 33 protected Indicates that the member documented in the comment block is protected i e should only be accessed by other members in the same or derived classes Note that Doxygen automatically detects the protection level of members in object oriented languages This com mand is intended for use only when the language does not support the concept of protection level natively e g C PHP 4 For starting a section of protected members in a way similar to the protected class marker in C use protectedsection See also sections memberof public private and protectedsection 21 34 protectedsection Starting a section of protected members in a way similar t
19. ImageResource QUrl mydata image png OVariant image Adding a resource Note that the lines containing the block markers will not be included so the output will be document gt addResource OTextDocument ImageResource QUrl mydata image png OVariant image Note also that the block_id markers should appear exactly twice in the source file see section dontinclude for an alternative way to include fragments of a source file that does not require markers 21 108 until pattern This command writes all lines of the example that was last included using include or dontinclude to the output until it finds a line containing the specified pattern The line containing the pattern will be written as well The internal pointer that is used to keep track of the current line in the example is set to the start of the line following last written line or to the end of the example if the pattern could not be found See section dontinclude for an example 21 109 verbinclude lt file name gt This command includes the file lt file name gt verbatim in the documentation The command is equivalent to pasting the file in the documentation and placing verbatim and endverbatim commands around it Files or directories that doxygen should look for can be specified using the EXAMPLE_PATH tag of doxygen s configuration file 21 110 htmlinclude lt file name gt This command includes the file lt file name
20. The Status column was generated from sources and shows approximately the last version when the translator was updated Language Maintainer Contact address Status Afrikaans Johan Prinsloo johan at zippysnoek dot com 1 6 0 Arabic Moaz Reyad resigned moazreyad at yahoo dot com 1 4 6 searching for the maintainer Please try to help to find someone Armenian Armen Tangamyan armen dot tangamyan at anu dot edu dot au up to date Brazilian Portuguese Fabio FJTC Jun Takada Chino jun chino at uol dot com dot br up to date Catalan Maximiliano Pin max dot pin at bitroit dot com up to date Albert Mora unreachable amora at iua dot upf dot es Chinese Lian Yang lian dot yang dot cn at gmail dot com up to date Li Daobing lidaobing at gmail dot com Wei Liu liuwei at asiainfo dot com Chinese Traditional Daniel YC Lin dlin dot tw at gmail dot com up to date Gary Lee garywlee at gmail dot com Croatian Boris Bralo boris dot bralo at gmail dot com up to date Czech Petr P ikryl prikrylp at skil dot cz up to date Danish Poul Erik Hansen pouhan at gnotometrics dot dk up to date Erik S e Sorensen eriksoe doxygen at daimi dot au dot dk Dutch Dimitri van Heesch dimitri at stack dot nl up to date English Dimitri van Heesch dimitri at stack dot nl up to date Esperanto Ander Martinez dwarfnauko at gmail dot com 1 7 5 Finnish Antti Laine antti dot a dot laine at tut dot fi 1 6 0 French David Ma
21. The htags tool is part of GNU s global source tagging system see http www gnu org software global global html To use it do the following 1 Install the latest version of global i e 4 8 6 or better a Enable SOURCE_BROWSER and USE_HTAGS in the config file b Make sure the INPUT points to the root of the source tree c Run doxygen as normal Doxygen will invoke htags and that will in turn invoke gtags so these tools must be available from the command line i e in the search path The result instead of the source browser generated by doxygen the links to source code will now point to the output of htags Generated by Doxygen 102 Configuration 20 7 Alphabetical index options ALPHABETICAL INDEX If the ALPHABETICAL INDEX tag is set to YES an alphabetical index of all com pounds will be generated Enable this if the project contains a lot of classes structs unions or interfaces COLS_IN_ALPHA INDEX Ifthe alphabetical index is enabled see ALPHABETICAL INDEX then the COL S_IN_ALPHA_ INDEX tag can be used to specify the number of columns in which this list will be split can be a number in the range 1 20 IGNORE_PREFIX In case all classes in a project start with a common prefix all classes will be put under the same header in the alphabetical index The IGNORE_PREF IX tag can be used to specify a prefix or a list of prefixes that should be ignored while generating the index heade
22. dot tool from graphviz to generate more advanced diagrams and graphs Graphviz is an open source cross platform graph drawing toolkit and can be foun If you have the dot tool in the path you can set HAVE_DOT to Y Doxygen uses the dot tool to generate the following graphs dathttp www graphviz org ES in the configuration file to let doxygen use it A graphical representation of the class hierarchy will be drawn along with the textual one Currently this feature is supported for HTML only Warning When you have a very large class hierarchy where many classes derive from a common base class the resulting image may become too big to handle for An inheritance graph will be generated for each documented relations This disables the generation of the built in class in some browsers class showing the direct and indirect inheritance heritance diagrams An include dependency graph is generated for each documented file that includes at least one other file This feature is currently supported for HTML and RTF only An inverse include dependency graph is also generated showing for a header file which other files include it A graph is drawn for each documented class and struct that the inheritance relations with base classes the usage relations with other structs and classes e class B then A has an arrow to B with m_a as label shows g class A has a member variable m_a of type
23. lt permission gt lde lt remarks gt ldentifie ntifies the security accessibility of a member Ignored by doxygen s the detailed description e lt returns gt Marks a piece of text as the return value of a function or method Similar to using return lt s cref memb e lt seealso cref member e lt summary gt Identifie r gt Refers to a member Similar to ref member gt Starts a See also section referring to member Similar to using sa s the brief description Similar to using brief e lt term gt Part of a lt list gt command 162 XML commands lt typeparam name paramName gt Marks a piece of text as the documentation for type parameter paramName Similar to using param e lt typeparamref name paramName gt Refers to a parameter with name paramName Similar to using la e lt value gt Identifies a property Ignored by doxygen Here is an example of a typical piece of code using some of the above commands lt summary gt A search engine lt summary gt class Engine lt summary gt The Search method takes a series of parameters to specify the search criterion and returns a dataset containing the result set lt summary gt lt param name connectionString gt the connection string to connect to the database holding the content to search lt param gt lt param name maxRows gt The maximum number of rows to return i
24. the default then doxygen will fill in an appropriate language specific title Generated by Doxygen 70 Customizing the Output You can reorder the tabs by moving the tab elements in the XML file within the navindex element and even change the tree structure Do not change the value of the type attribute however Only a fixed set of types are supported each representing a link to a specific index You can also add custom tabs using a type with name user Here is an example that shows how to add a tab with title Google pointing to www google com lt navindex gt lt tab type user url http www google com title Google gt lt navindex gt The url field can also be a relative URL If the URL starts with ref the link will point to a documented entities such as a class a function a group or a related page Suppose we have defined a page using page with label mypage then a tab with label My Page to this page would look as follows lt navindex gt lt tab type user url ref mypage title My Page gt lt navindex gt You can also group tabs together in a custom group using a tab with type usergroup The following example puts the above tabs in a user defined group with title My Group lt navindex gt lt tab type usergroup title My Group gt lt tab type user url http www google com title Google gt lt tab type user url ref mypage title My Page gt lt tab gt lt navindex gt
25. where the command with a single argument would still work as shown before Aliases can also be expressed in terms of other aliases e g a new command reminder can be expressed as a xrefitem via an intermediate xreflist command as follows ALIASES xreflist 3 xrefitem M1 2 3 ALIASES reminder xreflist reminders Reminder Reminders Note that if for aliases with more than one argument a comma is used as a separator if you want to put a comma inside the command you will need to escape it with a backslash i e l SomeClass Some text with an escaped comma given the alias definition of in the example above 13 3 Nesting custom command You can use commands as arguments of aliases including commands defined using aliases As an example consider the following alias definitions ALIASES Bold 1 lt b gt 1 lt b gt ALIASES Emph 1 lt em gt 1 lt em gt Inside a comment block you can now use x This is a Bold bold Emph and Emphasized text fragment x which will expand to x This is a lt b gt bold lt em gt and lt em gt Emphasized lt b gt text fragment x Generated by Doxygen Chapter 14 Link to external documentation If your project depends on external libraries or tools there are several reasons to not include all sources for these with every run of doxygen Disk space Some documentation may be available outside of the output directory of doxygen already for
26. 154 a IN A 154 e A E a e E A 154 A Se 6 heh iad ee he eeh edhe bel bebhet bbedee dh Abed eeba te ees 155 A A bee Eee eh hed ee SHO hE Poe See ed be eA 155 MN A eee i dey aoe pes ee ok ae eae eg ee oad Ee he oe oe ee ade Gan tek Ghee Bh aot 155 o oh ee bes ee ee Oe Ae ee eee ee eee oe ee ee 155 a oe E Se eS Ee Ee OES ES SE he ee ee eS 155 e III 155 UG 24th did dde o Pot bee li ee he da 155 22 HTML commands 157 23 XML commands 161 lll Developers Manual 163 24 Doxygen s internals 165 25 Perl Module Output format 169 2 USAS ceca k One Bide ee a a Oe A ee ee A aoe be he dee Cee eg Bd 169 20 2 Usingihe LaTeX generato G siis eek pao a a Pe a ea a 169 25 2 1 Gieaore PDF and DYLON so cn gk aci wd m a aa e me ok am a 170 25 0 Documentalon TO MAL socia OE be ee A PEO Peed ke ws 171 Bom Daa SUCUR AAA 171 26 Internationalization 173 Generated by Doxygen CONTENTS 1 Introduction Doxygen is a documentation system for C C Java Objective C Python IDL Corba and Microsoft flavors Fortran VHDL PHP CA and to some extent D It can help you in three ways 1 It can generate an on line documentation browser in HTML and or an off line reference manual in lATpX from a set of documented source files There is also support for generating output in RTF MS Word Post Script hyperlinked PDF compressed HTML and Unix man pages The documentation is extracted directly from the sources which makes it much easier to keep the d
27. 2 levels under the output directory of each output format and will distribute the generated files over these directories Enabling this option can be useful when feeding doxygen a huge amount of source files where putting all generated files in the same directory would otherwise causes performance problems for the file system OUTPUT_LANGUAGE The OUTPUT_LANGUAGI E tag is used to specify the language in which all documenta tion generated by doxygen is written Doxygen will use this information to generate all constant output in the proper language The default language is English other supported languages are Afrikaans Arabic Brazilian Catalan Chinese Croatian Czech Danish Dutch Finnish French German Greek Hungarian Italian Japanese Korean Lithuanian Norwegian Persian Polish Portuguese Romanian Russian Serbian Serbian Cyrillic Slovak Slovene Spanish Swedish and Ukrainian Generated by Doxygen 94 Configuration BRIEF_MEMBER_DESC If the BRIEF_MEMBER_DESC tag is set to YES the default doxygen will include brief member descriptions after the members that are listed in the file and class documentation similar to Java Doc Set to NO to disable this REPEAT_BRIEF Ifthe REPEAT_BRIEF tag is set to YES the default doxygen will prepend the brief description of a member or function before the detailed description Note If both HIDE_UNDOC
28. 6 Lists Extensions oo o sis ma 43 7 UseofasteriskS o 4 3 8 Limits on markup scope 4 4 Debugging of problems 5 Grouping 5 1 MOOWIES essa a OS ee ee Rw ee 52 WMemberGmups 23 05 2204 ae bd aoe ak ode bos db a So SULHI uroi eai ee PER EE DR ea ea eee 6 Including Formulas 7 Graphs and diagrams 8 Preprocessing 51 55 Generated by Doxygen CONTENTS 9 Automatic link generation 9 1 Links to web pages and Mail addresses e 9 2 L ksto AAA NR 9 3 DIESICTES sk cae koh A e e A e aa BO ee AE i 9 4 Links TO UMEUONDS lt ics el Gon a ra a we A A A we he BM eS 9 5 Links to oiher members o a a a A E oa Oe POIS cr coma ra la dia A ees Res 10 Output Formats 11 Searching 12 Customizing the Output 12 1 Minor Tweaks 12 1 1 Overall Color 12 1 2 Navigation 12 1 3 Dynamic Content 12 1 4 Header Footer and Stylesheet changes 2 0 000 eee eee eee 12 2 Changing the layout of pages 123 Using the XML output 13 Custom Commands 13 1 Simple aliases 13 2 Aliases with arguments 13 3 Nesting custom command 14 Link to external documentation 15 Frequently Asked Questions 16 Troubleshooting Il Reference Manual 17 Features 18 Doxygen usage 18 1 Fine tuning the output 19 Doxywizard usage 20 Configuration 20 1 Format oe saacanna 2
29. An example N I_2 left int_ 0 T psi t left u a t int_ gamma t a frac d theta k theta t int_ a theta c xi u_t xi t d xi right dt right XE results in mi f vo quan oor unas par 3 Formulas or other latex elements that are not in a math environment can be specified using f environment where environment is the name of the ATEX environment the corresponding end command is f Here is an example for an equation array 50 Including Formulas f eqnarray g amp amp frac Gm_2 r 2 AM amp amp frac 6 673 times 10 11 mbox m 3 mbox kg 1 mbox s 2 5 9736 times 10 24 mbox kg 6371 01 mbox km 2 amp amp 9 82066032 mbox m s 2 f which results in _ Gm ear 6 673 x 1071 m3 kg s 5 9736 x 10 kg 6371 01 km 9 82066032 m s For the first two commands one should make sure formulas contain valid commands in IATEX s math mode For the third command the section should contain valid command for the specific environment Warning Currently doxygen is not very fault tolerant in recovering from typos in formulas It may be necessary to remove the file formula repository that is written to the html directory to get rid of an incorrect formula Generated by Doxygen Chapter 7 Graphs and diagrams Doxygen has built in support to generate inheritance diagrams for C classes Doxygen can use the
30. Anatomy of a comment block 31 In this section we look at the contents of the comment block itself Doxygen supports various styles of formatting your comments The simplest form is to use plain text This will appear as is in the output and is ideal for a short description For longer descriptions you often will find the need for some more structure like a block of verbatim text a list or a simple table For this doxygen supports the Markdown syntax including parts of the Markdown Extra extension Markdown is designed to be very easy to read and write It s formatting is inspired by plain text mail Markdown works great for simple generic formatting like an introduction page for your project Doxygen also supports reading of markdown files directly See here for more details regards Markdown support For programming language specific formatting doxygen has two forms of additional markup on top of Markdown formatting 1 Javadoc like markup See here for a complete overview of all commands supported by doxygen 2 XML markup as specified in the C standard See here for the XML commands supported by doxygen If this is still not enough doxygen also supports a subset of the HTML markup language Generated by Doxygen 32 Documenting the code Generated by Doxygen Chapter 4 Markdown Markdown support was introduced in doxygen version 1 8 0 It is a plain text formatting syntax written by John Gruber with the
31. Doxygen 42 Markdown Generated by Doxygen Chapter 5 Grouping Doxygen has three mechanisms to group things together One mechanism works at a global level creating a new page for each group These groups are called modules in the documentation The second mechanism works within a member list of some compound entity and is referred to as a member groups For pages there is a third grouping mechanism referred to as subpaging 5 1 Modules Modules are a way to group things together on a separate page You can document a group as a whole as well as all individual members Members of a group can be files namespaces classes functions variables enums typedefs and defines but also other groups To define a group you should put the defgroup command in a special comment block The first argument of the command is a label that should uniquely identify the group The second argument is the name or title of the group as it should appear in the documentation You can make an entity a member of a specific group by putting a ingroup command inside its documentation block To avoid putting ingroup commands in the documentation for each member you can also group members together by the open marker before the group and the closing marker after the group The markers can be put in the documentation of the group definition or in a separate documentation block Groups themselves can also be nested using these grouping
32. HTML page Also here special com mands can be used This file contain the link to www doxygen org and the body and html end tags e customdoxygen css is the default cascading style sheet used by doxygen You should edit these files and then reference them from the config file e HTML_HEADER header html e HTML_FOOTER footer html e HTML_STYLESHEET customdoxygen css See the documentation of the HTML_HEADER tag for more information about the possible meta commands you can use inside your custom header Generated by Doxygen 12 2 Changing the layout of pages 69 Note You should not put the style sheet in the HTML output directory Treat it as a source file Doxygen will copy it for you If you use images or other external content in a custom header you need to make sure these end up in the HTML output directory yourself for instance by writing a script that runs doxygen can then copies the images to the output Warning The structure of headers and footers may change after upgrading to a newer version of doxygen so if you are using a custom header or footer it might not produce valid output anymore after upgrading 12 2 Changing the layout of pages In some cases you may want to change the way the output is structured A different style sheet or custom headers and footers do not help in such case The solution doxygen provides is a layout file which you can modify and doxygen will use to control what information is
33. INLINE_GROUPED_CLASSES 96 INLINE_INFO 97 INLINE_INHERITED_MEMB 94 INLINE_SOURCES 101 INPUT 100 INPUT_ENCODING 100 INPUT_FILTER 100 installation 7 INTERNAL_DOCS 97 JAVADOC_AUTOBRIEF 94 LaTeX 16 LATEX _BATCHMODE 107 LATEX _BIB_ STYLE 108 LATEX _CMD_NAME 107 LATEX_FOOTER 107 LATEX HEADER 107 LATEX _HIDE_INDICES 108 LATEX OUTPUT 107 LATEX _PDFLATEX 107 license 2 LOOKUP_CACHE_ SIZE 96 MACRO_EXPANSION 109 make 7 MAKEINDEX_CMD_NAME 107 MAN_LINKS 108 MAN_OUTPUT 108 MARKDOWN_SUPPORT 94 MATHJAX_EXTENSIONS 106 MATHJAX_RELPATH 106 MAX_DOT_GRAPH_DEPTH 112 MAX_EXTENSION 108 MAX_INITIALIZER_LINES 98 MSCFILE_DIRS 112 MSCGEN_PATH 110 MULTILINE_CPP_IS_ BRIEF 95 OPTIMIZE _FOR_FORTRAN 95 OPTIMIZE _OUTPUT_FOR_C 95 OPTIMIZE _OUTPUT_JAVA 95 OPTIMIZE _OUTPUT_SIP 95 OPTIMIZE _OUTPUT_VHDL 95 output formats 63 OUTPUT_DIRECTORY 93 OUTPUT_LANGUAGE 93 PAPER_TYPE 107 parsing 17 PDF_HYPERLINKS 107 Generated by Doxygen 182 INDEX perl 7 TAGFILES 110 PERL_PATH 110 TEMPLATE_RELATIONS 111 perlmod 169 TOC_EXPAND 105 PERLMOD_LATEX 109 PERLMOD_MAKEVAR_PREFIX 109 PERLMOD_PRETTY 109 PREDEFINED 110 PROJECT_NAME 93 PROJECT_NUMBER 93 QCH_FILE 105 QHG_LOCATION 105 QHP_CUST_FILTER_ATTRS 105 QHP_CUST_FILTER_NAME 105 QHP_NAMESPACE 105 QHP_SECT_FILTER_ATTRS 105 QHP_VIRTUAL_FOLDER 105 Qt 7 QT_AUTOBRIEF 94 QUIET 99 RECURSIVE 100 REFERENCED_BY_RELATION 101
34. RA ce ee G ae ss kde Re Rew ee ea ee BR ee a 21 29 page lt name gt tile 2 ee 21 30 private 21 31 privatesection 21 32 property qualified 21 33 protected 21 34 protectedsection 21 35 protocol lt name gt 21 36 public 21 37 publicsection 21 38 relates lt name gt 21 39 related lt name gt a AN lt header file gt lt header name gt o 21 40 VrelatesalSo lt name gt voi ceci er a ee PLAT waada boa MAME o o RR A ee a iR 21 42 showinitializer 21 43 struct lt name gt lt header file gt lt header name gt o o o o o oo 21 44 typedef typedef declaration o o 21 45 union lt name gt lt header file gt lt header name gt oo o 21 46 Ivar variable declaration o 21 47 weakgroup lt name gt title o o o o o ee 21 48 attention attention text o o o o e 21 49 author listo Authors E ee a a a ee i 21 50 authors list of aut ROS ii ic is Sea A a Soh e a ee et A 21 51 brief Diet descriplion o c e ce taran 5 ee be bbe bed BE eee ee bees 21 52 bug bug description 2 25 5 00 Cb ee ee Oa oe ER ER eR SS 21 53 con Sector label oooo bee ee EA a be Pe ea ee eS 21 54 copyright copyright description o 2155 dato date description 22 2 0 228522 RRR SHAR RR ERR EE ES 21 56 deprecated description
35. REFERENCES LINK SOURCE 101 REFERENCES RELATION 101 related 128 relatedalso 128 REPEAT BRIEF 94 RTF 16 RTF_HYPERLINKS 108 RTF_OUTPUT 108 RTF_STYLESHEET FILE 108 SEARCH_INCLUDES 110 SEARCHENGINE 105 SEPARATE_MEMBER_PAGES 95 SERVER_BASED_SEARCH 106 SHORT_NAMES 94 SHOW_DIRECTORIES 98 SHOW_FILES 98 SHOW_INCLUDE_FILES 97 SHOW_NAMESPACES 98 SHOW_USED_FILES 98 SKIP_FUNCTION_MACROS 110 SORT_BRIEF_DOCS 97 SORT_BY_SCOPE_NAME 97 SORT_GROUP_NAMES 97 SORT_MEMBER_DOCS 97 SORT_MEMBERS_CTORS_1ST 98 SOURCE_BROWSER 101 STRICT_PROTO_MATCHING 98 strip 7 STRIP_CODE_COMMENTS 101 STRIP_FROM_INC_PATH 94 STRIP_FROM_PATH 94 SUBGROUPING 96 SYMBOL_CACHE_SIZE 96 TAB_SIZE 95 TREEVIEW_WIDTH 106 TYPEDEF_HIDES_STRUCT 96 UML_LIMIT_NUM_FIELDS 111 UML_LOOK 111 USE_HTAGS 101 USE_INLINE_TREES 106 USE_MATHJAX 106 VERBATIM_HEADERS 101 WARN_FORMAT 99 WARN_IF_DOC_ERROR 99 WARN_IF_UNDOCUMENTED 99 WARN_LOGFILE 99 WARN_NO_PARAMDOC 99 WARNINGS 99 XML 16 XML_DTD 109 XML_OUTPUT 109 XML_PROGRAMLISTING 109 XML_SCHEMA 109 Generated by Doxygen
36. See also section Doxygen usage for information on how to generate the default style sheet that doxygen normally uses RTF_EXTENSIONS_FILE Set optional variables used in the generation of an RTF document Syntax is similar to doxygen s config file A template extensions file can be generated using doxygen e rtf extensionFile 20 11 Man page related options GENERATE_MAN If the GENERATE_MAN tag is set to YES the default doxygen will generate man pages for classes and files MAN_OUTPUT The MAN_OUTPUT tag is used to specify where the man pages will be put If a relative path is entered the value of OUTPUT_DIRECTORY will be put in front of it If left blank man will be used as the default path A directory man3 will be created inside the directory specified by MAN_OUTPUT MAN EXTENSION The MAN_EXTENSION tag determines the extension that is added to the generated man pages default is the subroutine s section 3 MAN_LINKS If the MAN_LINKS tag is set to YES and doxygen generates man output then it will generate one additional man file for each entity documented in the real man page s These additional files only source the real man page but without them the man command would be unable to find the correct page The default is NO Generated by Doxygen 20 12 XML related options 109 20 12 XML related options GENERATE_XML If the GENERATE_XML tag is set to YES Doxygen will generate an XML f
37. Sparamname description 21 69 tparam lt template parameter name gt description Starts a template parameter for a class or function template parameter with name lt template parameter name gt followed by a description of the template parameter Otherwise similar to param 21 70 post description of the postcondition Starts a paragraph where the postcondition of an entity can be described The paragraph will be indented The text of the paragraph has no special internal structure All visual enhancement commands may be used inside the paragraph Multiple adjacent post commands will be joined into a single paragraph Each postcondition will start on a new line Alternatively one post command may mention several postconditions The post command ends when a blank line or some other sectioning command is encountered 21 71 pre description of the precondition Starts a paragraph where the precondition of an entity can be described The paragraph will be indented The text of the paragraph has no special internal structure All visual enhancement commands may be used inside the paragraph Multiple adjacent pre commands will be joined into a single paragraph Each precondition will start on a new line Alternatively one pre command may mention several preconditions The pre command ends when a blank line or some other sectioning command is encountered Generated by Doxygen 136 Special Commands 21 72 remark remar
38. Starts a paragraph where one or more warning messages may be entered The paragraph will be indented The text of the paragraph has no special internal structure All visual enhancement commands may be used inside the paragraph Multiple adjacent warning commands will be joined into a single paragraph Each warning descrip tion will start on a new line Alternatively one warning command may mention several warnings The warning command ends when a blank line or some other sectioning command is encountered See section author for an example 21 88 xrefitem lt key gt heading list title text This command is a generalization of commands such as todo and bug It can be used to create user defined text sections which are automatically cross referenced between the place of occurrence and a related page which will be generated On the related page all sections of the same type will be collected The first argument lt key gt is an identifier uniquely representing the type of the section The second argument is a quoted string representing the heading of the section under which text passed as the fourth argument is put The third argument list title is used as the title for the related page containing all items with the same key The keys todo test bug and deprecated are predefined To get an idea on how to use the xrefitem command and what its effect is consider the todo list which for English output can be see
39. The description of the first enum value 21 11 example lt file name gt Indicates that a comment block contains documentation for a source code example The name of the source file is lt file name gt The text of this file will be included in the documentation just after the documentation contained in the comment block All examples are placed in a list The source code is scanned for documented members and classes If any are found the names are cross referenced with the documentation Source files or directories can be specified using the EXAMPLE_PATH tag of doxygen s configuration file If lt file name gt itself is not unique for the set of example files specified by the EXAMPLE_PATH tag you can include part of the absolute path to disambiguate it If more than one source file is needed for the example the include command can be used Example A Test class More details about this class Generated by Doxygen 120 Special Commands class Test public x x An example member function More details about this function void example y void Test example x x Nexample example_test cpp This is an example of how to use the Test class More details about this example Where the example file example_test cpp looks as follows void main Test ty t example See also section include 21 12 endinternal This command ends a documentation fragment that
40. This is a very simple Perl mod ule that contains only two statements an assignment to the variable doxydocs and the customary 1 statement which usually ends Perl modules The documentation is stored in the variable doxydocs which can then be accessed by a Perl script using DoxyDocs pm doxydocs contains a tree like structure composed of three types of nodes strings hashes and lists Strings These are normal Perl strings They can be of any length can contain any character Their semantics depends on their location within the tree This type of node has no children e Hashes These are references to anonymous Perl hashes A hash can have multiple fields each with a different key The value of a hash field can be a string a hash or a list and its semantics depends on the key of the hash field and the location of the hash within the tree The values of the hash fields are the children of the node e Lists These are references to anonymous Perl lists A list has an undefined number of elements which are the children of the node Each element has the same type string hash or list and the same semantics depending on the location of the list within the tree As you can see the documentation contained in doxydocs does not present any special impediment to be pro cessed by a simple Perl script 25 4 Data structure You might be interested in processing the documentation contained in DoxyDocs pm without needing to take into accou
41. XML file you can combine the index and the other files using the XSLT file combine xslt Generated by Doxygen 72 Customizing the Output You can use any XML parser to parse the file or use the one that can be found in the addon doxmlparser directory of doxygen source distribution Look at addon doxmlparser include doxmlintf h for the interface of the parser and in addon doxmlparser example for examples The advantage of using the doxmlparser is that it will only read the index file into memory and then only those XML files that you implicitly load via navigating through the index As a result this works even for very large projects where reading all XML files as one big DOM tree would not fit into memory See the Breathe project for a example that uses doxygen XML output from Python to bridge it with the Sphinx document generator Generated by Doxygen Chapter 13 Custom Commands Doxygen provides a large number of special commands XML commands and HTML commands that can be used to enhance or structure the documentation inside a comment block If you for some reason have a need to define new commands you can do so by means of an alias definition The definition of an alias should be specified in the configuration file using the ALIASES configuration tag 13 1 Simple aliases The simplest form of an alias is a simple substitution of the form name value For example defining the following alias ALIASES sideeffect
42. a os e Be A BAR Ro ee bee eee 149 Bi jee COTE 2s dx a oe es eo a ee de a ee dee ig Ge as 149 DIAL EDO ica did EE PEA Sew eh hd Be She let Ae 149 BIA endimee o ee Pa ee Peed eae dee Ee bab ba wd 149 BU Tee Brimley ccc ej een BS E E pee SU ES a om Pe EE oe wad aCe 149 21 129 endlaiexanhy ce soies a ea a aa Re PES Pe bee ee a 149 A o so a i io he oe He a Pe Ee ee CARO BEE ae aS 149 ABI o beh hed Od be BONS POS de oa ee BE Eee phd bh hee 150 Zio PONEN iore A RE ee BA ee ERR AE ee AAA i 150 UTS Sree wea ee ee Oe ee he ee eee ee ee ak oe aed ee 150 a 6 oe Gite oo SE ee e eS Ee EE Ea ho Se ee ay a bt ee ee 150 PUM III 150 PAS ia a a A e A aa i 150 AREA C a 226 eek a a E ee 151 NI A i a ne a Gee at A ee ee eee 151 ZII Vimo ws ke ey ee A RA ee Paes ee Oe Pe OE ee Pw 151 21 140 image lt format gt lt file gt caption lt sizeindication gt lt size gt o o 151 iS GO e te Yee ame Gs as EEG ER RY a ee bee ee ew hae a 152 PLUTARCO o ee hig ee doe Be 8 Ree AA a a ee es 152 21 143 iit itein deseription o e s ac 5556 a EE Pee aE Re eee eee ee oe 152 Generated by Doxygen 10 CONTENTS PRIMI caia a a PED e a OS 153 PUTA PARES eu is ek SA Bone eae RA E ARE Pe eh eae A BS 153 PEA o e ee Ve A dd A 153 ELIO ia AA a A ARE A A A 153 TAR IONE oo a Gel ee ee eS a ae eA ae Pee a 154 MAD 42 bedded eb ee oboe bbe RPE SUES PSS 4 beh eds She at eat eee 154 A a Mo hot head oye ens SOA A Se eee Bee ee gt eee a E 154 PIAS le II
43. and allows to open a configuration file from disk Save as This is the same as the Save button in the main window and can be used to save the current configu ration settings to disk Recent configurations Allow to quickly load a recently saved configuration Set as default Stores the current configuration settings as the default to use next time the GUI is started You will be asked to confirm the action Reset Restores the factory defaults as the default settings to use You will be asked to confirm the action Generated by Doxygen Chapter 20 Configuration 20 1 Format A configuration file is a free form ASCII text file with a structure that is similar to that of a Makefile with the default name Doxyfile ltis parsed by doxygen The file may contain tabs and newlines for formatting purposes The statements in the file are case sensitive Comments may be placed anywhere within the file except within quotes Comments begin with the character and end at the end of the line The file essentially consists of a list of assignment statements Each statement consists of a TAG_NAME written in capitals followed by the character and one or more values lf the same tag is assigned more than once the last assignment overwrites any earlier assignment For options that take a list as their argument the operator can be used instead of to append new values to the list Values are sequences of non blanks If the value shou
44. can be used to specify a user defined HTML footer for each generated HTML STYLESHEET The HTML _STYLESH HTML page If the tag is left blank doxygen will generate a standard footer See HTML_HEADER for more information on how to generate a default footer and what special commands can be used inside the footer See also section Doxygen usage for information on how to generate the default footer that doxygen normally uses T ET tag can be used to specify a user defined cascading style sheet that is used by each HTML page It can be used to fine tune the look of the HTML output If the tag is left blank doxygen will generate a default style sheet See also section Doxygen usage for information on how to generate the style sheet that doxygen normally uses HTML_EXTRA_FILES The HTML_EXTRA_FILES tag can be used to specify one or more extra images or other source files which should be copied to the HTML output directory Note that these files will be copied to the base HTML output directory Use the relpath marker in the HTML_ HEADER and or HTML_FOOTER files to load these files In the HTML_ STYLESHEET file use the file name only Also note that the files will be copied as is there are no commands or markers available T Generated by Doxygen 104 Configuration HTML COLORSTYLE_HUE The HTML_COLORSTYLE_HUE tag controls the color of the HTML output Doxygen will ad
45. distribution 4 Optional Generate the user manual make docs To let doxygen generate the HTML documentation The HTML directory of the distribution will now contain the html documentation just point a HTML browser to the file index html in the html directory You will need the python interpreter for this 5 Optional Generate a PDF version of the manual you will need pdflatex makeindex and egrep for this make pdf The PDF manual doxygen_manual pdf will be located in the latex directory of the distribution Just view and print it via the acrobat reader 1 2 Installing the binaries on UNIX After the compilation of the source code do a make install to install doxygen If you downloaded the binary distribution for UNIX type configure make install Binaries are installed into the directory lt prefix gt bin Use make install_docs to install the documen tation and examples into lt docdir gt doxygen lt prefix gt defaults to usr local but can be changed with the prefix option of the configure script The default lt docdir gt directory is lt prefix gt share doc packages and can be changed with the docdir option of the configure script Alternatively you can also copy the binaries from the bin directory manually to some bin directory in your search path This is sufficient to use doxygen Note You need the GNU install tool for this to work it is part of the coreutils package Other install too
46. documentation The third part provides information for developers Section Doxygen s Internals gives a global overview of how doxygen is internally structured e Section Perl Module Output shows how to use the PerlMod output e Section Internationalization explains how to add support for new output languages Doxygen license Copyright 1997 2012 by Dimitri van Heesch Permission to use copy modify and distribute this software and its documentation under the terms of the GNU General Public License is hereby granted No representations are made about the suitability of this software for any purpose It is provided as is without express or implied warranty See the GNU General Public License for more details Documents produced by doxygen are derivative works derived from the input used in their production they are not affected by this license User examples Doxygen supports a number of output formats where HTML is the most popular one I ve gathered some nice examples see http www doxygen org results htm1 of real life projects using doxygen These are part of a larger list of projects that use doxygen see http www doxygen org projects html If you know other projects let me know and l Il add them Commercial Support I m currently investigating the possibilities of providing commercial support for doxygen The forms of support I m thinking of are implementing features e fixing bugs providing p
47. e ST tees heh Rea ahaa 2 21 91 endrtfonly o 4 aan a he oi a 21 131 yolas se o A LE a e hee ae 21 6 endverbatim 0 0 0 000040 21 132 NGOdE ve id bs de KB eh Ae a 20t endxmlonly 2 24 40 loa hak a ad 21 133 NGONO id ad ae eae i RE te 21 59 NGUT a 2 3 hoe ah Se GOA a cad e da 21 10 eopyblief 2 a rara ae MATE Nexample oia a ede SES 21 11 copydetails we ee aey Be e aA SUAVE exception naia at ao ew A Se e 21 62 COPYdOGs site ba sem Satie ads hh eh an eR BA FLNE extehds a ee a a ee A he ee A 21 13 eopylight 4 oe be PA gale A eee aa lye 21 54 NIG ce OLA as Ach aoe Glade oa tobe Qiao cect E ena 21 134 A x ot he Bees he erate an A one ete een eee 21 135 Vde etag a a a e E hae Son 21 7 EA det ees Coe Ace octet 21 136 defgrolp gt lt ha a ee de baa eee Gee 21 8 Miss ded Baa 2 Bee oe A eee ae 21 137 deprecated seor e ce cae Ses Rew ee T 21 56 A A 21 138 d talls 340 dr a ee 2157 A A ee eo hk 21 14 Min tee a arta hate cummin Kents ots 21 9 MAID fast oo Bee ey etter eet sets ts cathe 21 15 dontinclude 2 21001 headerfiles coca OE Se ee 21 16 dOt ais S46 A244 Aaa Miss ed Salas Bae 21 419 hideinitializer 234 025 cs een ee ee vena 2117 116 Special Commands htmlinclud 2 2 2 Sa ca Sandee 21490 NremarkS coc oe Dee he See we ad 21 73 htmloniy 202 eos ee ee ea ae ee Be Res 21189 WESUIb eee ee a a ae ee a eo ei 21 74 Nf Pas pet Ge Gh tow tte saa Beh wy SU Ge Ate a tetas 21 63 NOU iaa A e a
48. e if CALL_GRAPH is set to YES a graphical call graph is drawn for each function showing the functions that the function directly or indirectly calls e if CALLER_GRAPH is set to YES a graphical caller graph is drawn for each function showing the functions that the function is directly or indirectly called by Using a layout file you can determine which of the graphs are actually shown The options DOT_GRAPH_MAX_NODES and MAX_DOT_GRAPH_DEPTH can be used to limit the size of the various graphs The elements in the class diagrams in HTML and RTF have the following meaning A yellow box indicates a class A box can have a little marker in the lower right corner to indicate that the class contains base classes that are hidden For the class diagrams the maximum tree width is currently 8 elements If a tree is wider some nodes will be hidden If the box is filled with a dashed pattern the inheritance relation is virtual 52 Graphs and diagrams A white box indicates that the documentation of the class is currently shown A gray box indicates an undocumented class A solid dark blue arrow indicates public inheritance A dashed dark green arrow indicates protected inheritance A dotted dark green arrow indicates private inheritance The elements in the class diagram in IATEX have the following meaning A white box indicates a class A marker in the lower right corner of the box indicates that the class has base classes that ar
49. eat ed 21 41 A iia ge mn ee a Gg atte ges genes ann oe N 21 158 Nrelalesalso odia bee ee om ws 21 40 Mier ae ate ain es da Gh ak ven Se E eg te 21 159 Nemak cana wee asst a See eh asda andes as Staats ah 21 72 NES accep Gn Medi oaks pve yee aoe tos a A 21 160 The following subsections provide a list of all commands that are recognized by doxygen Unrecognized commands are treated as normal text Structural indicators 21 2 addtogroup lt name gt title Defines a group just like defgroup but in contrast to that command using the same lt name gt more than once will not result in a warning but rather one group with a merged documentation and the first title found in any of the commands The title is optional so this command can also be used to add a number of entities to an existing group using and like this x addtogroup mygrp Additional documentation for group mygrp x f Generated by Doxygen 21 3 callgraph 117 x A function void funcl Another function x void func2 x x See also page Grouping sections defgroup ingroup and weakgroup 21 3 callgraph When this command is put in a comment block of a function or method and HAVE_DOT is set to YES then doxy gen will generate a call graph for that function provided the implementation of the function or method calls other documented functions The call graph will be generated regard
50. file is not limited to Windows Disadvantage is that it requires setting up a Qt 4 5 or better for each user or distributing the Qt help assistant along with the documentation which is complicated by the fact that it is not available as a separate package at this moment 6 Eclipse Help Plugin If you use eclipse you can embed the documentation generated by doxygen as a help plugin It will then appear as a topic in the help browser that can be started from Help contents in the Help menu Eclipse will generate a search index for the documentation when you first search for an keyword To enable the help plugin set GENERATE _ECLIPSEHELP to YES and define a unique identifier for your project via ECLIPSE_DOC_ID i e GENERATE_ECLIPSEHELP ECLIPSE_DOC_ID YES com yourcompany yourproject sll then create the com yourcompany yourproject directory so with the same name as the value of ECLIP SE_DOC_ID in the plugin directory of eclipse and after doxygen completes copy to contents of the help output directory to the com yourcompany yourproject directory Then restart eclipse to make let it find the new plugin The eclipse help plugin provides similar functionality as the Qt compressed help or CHM output but it does require that Eclipse is installed and running Generated by Doxygen Chapter 12 Customizing the Output Doxygen provides various levels of customization The section Minor Tweaks discusses what to do i
51. for the particular files in the Makefile Gcc versions before 2 95 may produce broken binaries due to bugs in these compilers Dot problems Due to a change in the way image maps are generated older versions of doxygen lt 1 2 17 will not work correctly with newer versions of graphviz gt 1 8 8 The effect of this incompatibility is that generated graphs in HTML are not properly clickable For doxygen 1 3 it is recommended to use at least graphviz 1 8 10 or higher For doxygen 1 4 7 or higher it is recommended to use GraphViz 2 8 or higher to avoid font issues Red Hat 9 0 problems If you get the following error after running make tmake error qtools pro 70 Syntax error then first type export LANG before running make Generated by Doxygen 1 4 Compiling from source on Windows 11 1 4 Compiling from source on Windows From version 1 7 0 onwards build files are provided for Visual Studio 2008 Also the free as in beer Express version of Developer Studio can be used to compile doxygen Alternatively you can compile doxygen the UNIX way using Cygwin or MinGW The next step is to install unxutils see http sourceforge net projects unxutils This packages contains the tools flex and bison which are needed during the compilation process if you use a CVS snapshot of doxygen the official source releases come with pre generated sources Download the zip extract it to e g c tools unxutils Now you need to add adju
52. in the search path 21 92 endlink This command ends a link that is started with the link command See also section link 21 93 link lt link object gt The links that are automatically generated by doxygen always have the name of the object they point to as link text The link command can be used to create a link to an object a file class or member with a user specified link text The link command should end with an endlink command All text between the link and endlink commands serves as text for a link to the lt link object gt specified as the first argument of link See section autolink for more information on automatically generated links and valid link objects 21 94 ref lt name gt text Creates a reference to a named section subsection page or anchor For HTML documentation the reference command will generate a link to the section For a section or subsection the title of the section will be used as the text of the link For an anchor the optional text between quotes will be used or lt name gt if no text is specified For lATEX documentation the reference command will generate a section number for sections or the text followed by a page number if lt name gt refers to an anchor See also Section page for an example of the ref command 21 95 subpage lt name gt text This command can be used to create a hierarchy of pages The same structure can be made using the defgroup an
53. indirect implementation de pendencies inheritance containment and class references variables of the class with other documented classes GROUP_GRAPHS If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen will generate a graph for groups showing the direct groups dependencies UML_LOOK If the UML_LOOK tag is set to YES doxygen will generate inheritance and collaboration diagrams in a style similar to the OMG s Unified Modeling Language UML_LIMIT_NUM_FIELDS f the UML_LOOK tag is enabled the fields and methods are shown inside the class node If there are many fields or methods and many nodes the graph may become too big to be useful The UML_LIMIT_NUM_FIELDS threshold limits the number of items for each type to make the size more managable Set this to 0 for no limit Note that the threshold may be exceeded by 50 before the limit is enforced So when you set the threshold to 10 up to 15 fields may appear but if the number exceeds 15 the total amount of fields shown is limited to 10 T TEMPLATE RELATIONS lfthe TEMPLATE_RELATIONS and HAVE_DOT tags are set to YES then doxygen will show the relations between templates and their instances HIDE _UNDOC_RELATIONS If set to YES the inheritance and collaboration graphs will hide inheritance and usage relations if the target is undocumented or is not a class INCLUDE_GRAPH If the ENABLE _PREPROCESSING SEARCH_INCLUDE
54. into MAN pages You can use the htmlonly and latexonly and endhtmlonly and endlatexonly pairs to provide proper HTML and IATEX alternatives See also section htmlonly section xmlonly section rtfonly and section latexonly 21 143 Ali item description This command has one argument that continues until the first blank line or until another li is encountered The command can be used to generate a simple not nested list of arguments Each argument should start with a li command Example Typing Generated by Doxygen 21 144 n 153 Mi c AlignLeft left alignment li c AlignCenter center alignment Mi c AlignRight right alignment No other types of alignment are supported will result in the following text AlignLeft left alignment e AlignCenter center alignment AlignRight right alignment No other types of alignment are supported Note For nested lists HTML commands should be used Equivalent to arg 21 144 An Forces a new line Equivalent to lt br gt and inspired by the printf function 21 145 Ap lt word gt Displays the parameter lt word gt using a typewriter font You can use this command to refer to member function parameters in the running text Example the p x and p y coordinates are used to This will result in the following text the x and y coordinates are used to Equivalent to c To have multiple words in typewriter font use lt tt gt mul
55. language after the opening fence For highlighting according to the Python language for instance you would need to write the following A class class Dummy pass which will produce A class class Dummy pass and for C you would write int func int a int b return axb which will produce int func int a int b return axb The curly braces and dot are optional by the way 4 2 4 Header Id Attributes Standard Markdown has no support for labeling headers which is a problem if you want to link to a section PHP Markdown Extra allows you to label a header by adding the following to the header Header 1 labelid Header 2 labelid2 To link to a section in the same comment block you can use Link text labelid to link to a section in general doxygen allows you to use ref Link text ref labelid Note this only works for the headers of level 1 to 4 4 3 Doxygen specifics Even though doxygen tries to following the Markdown standard as closely as possible there are couple of deviation and doxygen specifics additions 4 3 1 Including Markdown files as pages Doxygen can process files with Markdown formatting For this to work the extension for such a file should be md or markdown see EXTENSION_MAPPING if your Markdown files have a different extension and use md as the name of the parser Each file is converted to a page see the page command for details Generated by Doxygen 4
56. last one To append to an existing option you can use the operator 18 How did doxygen get its name Doxygen got its name from playing with the words documentation and generator documentation gt docs gt dox generator gt gen At the time was looking into lex and yacc where a lot of things start with yy so the y slipped in and made things pronounceable the proper pronouncement is Docs ee gen so with a long e 19 What was the reason to develop doxygen once wrote a GUI widget based on the Qt library it is still available at http qdbttabular sourceforge net and maintained by Sven Meyer Qt had nicely generated documentation using an internal tool which they didn t want to release and wrote similar docs by hand This was a nightmare to maintain so wanted a similar tool looked at Doc but that just wasn t good enough it didn t support signals and slots and did not have the Qt look and feel had grown to like so started to write my own tool Generated by Doxygen Chapter 16 Troubleshooting Known problems If you have problems building doxygen from sources please read this section first Doxygen is not a real compiler it is only a lexical scanner This means that it can and will not detect errors in your source code e Since it is impossible to test all possible code fragments it is very well possible that some valid piece of C C code is not handled properly If you find suc
57. lead to badly anti aliased labels on the edges of a graph i e they become hard to read DOT_MULTI_TARGETS Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output files in one run i e multiple o and T options on the command line This makes dot run faster but since only newer versions of dot gt 1 8 10 support this this feature is disabled by default GENERATE_LEGEND lf the GENERATE_LEGEND tag is set to YES the default doxygen will generate a legend page explaining the meaning of the various boxes and arrows in the dot generated graphs DOT_CLEANUP If the DOT_CLEANUP tag is set to YES the default doxygen will remove the intermediate dot files that are used to generate the various graphs Generated by Doxygen 20 17 Dot options 113 Examples Suppose you have a simple project consisting of two files a source file example cc and a header file example h Then a minimal configuration file is as simple as INPUT example cc example h Assuming the example makes use of Qt classes and perl is located in usr bin a more realistic configuration file would be PROJECT_NAME Example INPUT example cc example h WARNINGS YES TAGFILES gt tag PERL_PATH usr local bin perl SEARCHENGINE NO To generate the documentation for the Odbt Tabular package have used the following configuration file PROJECT_NAME QdbtTabular OUTPUT_DIRECTORY html WAR
58. located in front of the function declaration or defini tion the optional argument should be used to specify the correct function Any other documentation that is inside the documentation block will by appended after the generated message Note 1 You are responsible that there is indeed an earlier documented member that is overloaded by this one To prevent that document reorders the documentation you should set SORT_MEMBER_DOCS to NO in this case Note 2 The overload command does not work inside a one line comment Example class Test public void drawRect int int int int Generated by Doxygen 21 28 package lt name gt 125 void drawRect const Rect amp r y void Test drawRect int x int y int w int h void Test drawRect const Rect amp r x class Test x brief A short description More text x fn void Test drawRect int x int y int w int h This command draws a rectangle with a left upper corner at a x ay x width Na w and height la h x overload void Test drawRect const Rect amp r 21 28 package lt name gt Indicates that a comment block contains documentation for a Java package with name lt name gt 21 29 page lt name gt title Indicates that a comment block contains a piece of documentation that is not directly related to one specific class file or member The HTML generator creates a page containing the documentation The
59. long By putting this command in a comment block of a define or variable the initializer is shown unconditionally The maximum number of initialization lines can be changed by means of the configuration parameter MAX_INITIALIZE R_LINES the default value is See also 1 section hideinitializer 21 43 struct lt name gt lt header file gt lt header name gt Indicates that a comment block contains documentation for a struct with name lt name gt The arguments are equal to the arguments of the class command See also section class 21 44 typedef typedef declaration Indicates that a comment block contains documentation for a typedef either global or as a member of a class This command is equivalent to var property and fn Generated by Doxygen 21 45 union lt name gt lt header file gt lt header name gt 129 See also section fn property and Ivar 21 45 union lt name gt lt header file gt lt header name gt Indicates that a comment block contains documentation for a union with name lt name gt The arguments are equal to the arguments of the class command See also section class 21 46 var variable declaration Indicates that a comment block contains documentation for a variable or enum value either global or as a member of aclass This command is equivalent to typedef property and fn See also section fn property and typedef 21 47 weakgroup
60. lt name gt title Can be used exactly like addtogroup but has a lower priority when it comes to resolving conflicting grouping definitions See also page Grouping and section addtogroup Section indicators 21 48 attention attention text Starts a paragraph where a message that needs attention may be entered The paragraph will be indented The text of the paragraph has no special internal structure All visual enhancement commands may be used inside the paragraph Multiple adjacent attention commands will be joined into a single paragraph The attention command ends when a blank line or some other sectioning command is encountered 21 49 author list of authors Starts a paragraph where one or more author names may be entered The paragraph will be indented The text of the paragraph has no special internal structure All visual enhancement commands may be used inside the paragraph Multiple adjacent author commands will be joined into a single paragraph Each author description will start a new line Alternatively one author command may mention several authors The author command ends when a blank line or some other sectioning command is encountered Example Ir brief Pretty nice class Generated by Doxygen 130 Special Commands Adetails This class is used to demonstrate a number of section commands x author John Doe x author Jan Doe x version 4 la x Adate 1990 2011 pre First in
61. make it available under the help contents menu in Eclipse the contents of the directory containing the HTML and XML files needs to be copied into the plugins directory of eclipse The name of the directory within the plugins directory should be the same as the ECLIPSE_DOC_ID value After copying Eclipse needs to be restarted before the help appears ECLIPSE_DOC_ID A unique identifier for the eclipse help plugin When installing the plugin the directory name containing the HTML and XML files should also have this name Each documentation set should have its own identifier SEARCHENGINE When the SEARCHENGINE tag is enabled doxygen will generate a search box for the HTML output The underlying search engine uses javascript and DHTML and should work on any modern browser Note that when using HTML help GENERATE_HTMLHELP Qt help GENERATE_QHP or docsets G ENERATE_DOCSET there is already a search function so this one should typically be disabled For large projects the javascript based search engine can be slow then enabling SERVER_BASED SEARCH may provide a better solution It is possible to search using the keyboard to jump to the search box use access key S what the access key is depends on the OS and browser but it is typically CTRL ALT option or both Inside the search box use the cursor down key to jump into the search results window the results can be navigated using the cursor keys Press Enter to select an item or esc
62. many language translators implemented the obsolete method so it perfectly makes sense to use the same language dependent result in those cases The TranslatorEnglish does not implement the old method It derives from the abstract Translator class On the other hand the old translator for a different language does not implement the new trFile method Because of that it is derived from another base class TranslatorAdapter_x_y_z The TranslatorAdapter_x_y_z class have to implement the new required trFile method However the translator adapter would not be compiled if the trFiles method was not implemented This is the reason for implementing the old method in the translator adapter class using the same code that was removed from the TranslatorEnglish The simplest way would be to pass the arguments to the English translator and to return its result Instead the adapter uses the old trFiles in one special case when the new trFile true false is called This is the mostly used case at the time of introducing the new method see above While this may look too complicated the technique allows the developers of the core sources to change the Translator interface while the users may not even notice the change Of course when the new trFile is used with different arguments the English result is returned and it will be noticed by non English users Here the maintainer of the language translator should implement at least that one part
63. matching endi f command This conditional section is enabled by default To disable it you must put the section label after the ENABLED_SECTIONS tag in the configuration file See also sections endif if else and elseif Generated by Doxygen 134 Special Commands 21 65 invariant description of invariant Starts a paragraph where the invariant of an entity can be described The paragraph will be indented The text of the paragraph has no special internal structure All visual enhancement commands may be used inside the paragraph Multiple adjacent invariant commands will be joined into a single paragraph Each invariant description will start on a new line Alternatively one invariant command may mention several invariants The invariant command ends when a blank line or some other sectioning command is encountered 21 66 Anote text Starts a paragraph where a note can be entered The paragraph will be indented The text of the paragraph has no special internal structure All visual enhancement commands may be used inside the paragraph Multiple adjacent note commands will be joined into a single paragraph Each note description will start on a new line Alternatively one note command may mention several notes The note command ends when a blank line or some other sectioning command is encountered See section par for an example 21 67 par paragraph title paragraph If a paragraph title is given this
64. may help to save some trees in general PAPER_TYPE The PAPER_TYPE tag can be used to set the paper type that is used by the printer Possible values are e a4 210 x 297 mm e letter 8 5 x 11 inches e legal 8 5 x 14 inches executive 7 25 x 10 5 inches If left blank a4 will be used EXTRA_PACKAGES The EXTRA_PACKAGES tag can be used to specify one or more IATEX package names that should be included in the IATEX output To get the times font for instance you can specify EXTRA_PACKAGES times If left blank no extra packages will be included LATEX HEADER The LATEX_HEADER tag can be used to specify a personal ATEX header for the generated ATEX document The header should contain everything until the first chapter If it is left blank doxygen will generate a standard header See section Doxygen usage for information on how to let doxygen write the default header to a separate file Note Only use a user defined header if you know what you are doing The following commands have a special meaning inside the header title datetime date Sdoxygenversion projectname projectnumber Doxygen will replace them by respectively the title of the page the current date and time only the current date the version number of doxygen the project name see PROJECT_NAME or the project number see PROJECT_NUMBER LATEX FOOTER The LATEX_FOOTER tag can be used to specify a pe
65. not enabled The previous section should have been started with a i f i fnot or elseif command See also if ifnot elseif endif 21 59 elseif lt section label gt Starts a conditional documentation section if the previous section was not enabled A conditional section is disabled by default To enable it you must put the section label after the ENABLED_SECTIONS tag in the configuration file Conditional blocks can be nested A nested section is only enabled if all enclosing sections are enabled as well See also sections endif ifnot else and elseif 21 60 endcond Ends a conditional section that was started by cond See also section cond 21 61 endif Ends a conditional section that was started by if or i fnot For each if or i fnot one and only one matching endif must follow See also sections if and ifnot 21 62 exception lt exception object gt exception description Starts an exception description for an exception object with name lt exception object gt Followed by a description of the exception The existence of the exception object is not checked The text of the paragraph has no special internal structure All visual enhancement commands may be used inside the paragraph Multiple adjacent exception commands will be joined into a single paragraph Each exception description will start on a new line The exception description ends when a blank line or some other sectioning comma
66. not something is a bug please ask help on the users mailing list first sub scription is required If you send only a vague description of a bug you are usually not very helpful and it will cost me much more time to figure out what you mean In the worst case your bug report may even be completely ignored by me so always try to include the following information in your bug report The version of doxygen you are using for instance 1 5 3 use doxygen version if you are not sure The name and version number of your operating system for instance SuSE Linux 6 4 It is usually a good idea to send along the configuration file as well but please use doxygen with the s flag while generating it to keep it small use doxygen s u configName to strip the comments from an existing config file The easiest and often the only way for me to fix bugs is if you can attach a small example demonstrating the problem you have to the bug report so can reproduce it on my machine Please make sure the example is valid source code could potentially compile and that the problem is really captured by the example I often get examples that do not trigger the actual bug If you intend to send more than one file please zip or tar the files together into a single file for easier processing Note that when reporting a new bug you ll get a chance to attach a file to it only after submitting the initial bug description You can and are encouraged t
67. of bold text lt STRONG gt Ends a section of bold text lt SUB gt Starts a piece of text displayed in subscript lt SUB gt Ends a lt SUB gt section Generated by Doxygen 159 The special HTML character entities that are recognized by Doxygen lt SUP gt Starts a piece of text displayed in superscript lt SUP gt Ends a lt SUP gt section lt TABLE gt starts a table lt TABLE gt ends a table lt TD gt Starts a new table data element lt TD gt Ends a table data element lt TH gt Starts a new table header lt TH gt Ends a table header lt TR gt Starts a new table row lt TR gt Ends a table row lt TT gt Starts a piece of text displayed in a typewriter font lt TT gt Ends a lt TT gt section lt KBD gt Starts a piece of text displayed in a typewriter font lt KBD gt Ends a lt KBD gt section lt UL gt Starts an unnumbered item list lt UL gt Ends an unnumbered item list lt VAR gt Starts a piece of text displayed in an italic font lt VAR gt Ends a lt VAR gt section amp copy the copyright symbol amp tm the trade mark symbol amp xreg the registered trade mark symbol amp 1t less than symbol amp gt greater than symbol amp amp ampersand amp apos single quotation mark straight amp quot double quotation mark straight 1squo left single quotation mark amp xrsquo right single quotation mark amp 1ldquo le
68. options may use relative paths the next step is to select a directory from which to run doxygen This is typically the root of the source tree and will most of the time already be filled in correctly Once the configuration file is saved and the working directory is set you can run doxygen based on the selected settings Do this by pressing the Start button Once doxygen runs you can cancel it by clicking the same button again The output produced by doxygen is captured and shown in a log window Once doxygen finishes the log can be saved as a text file The Wizard Dialog If you select the Wizard button in step 1 then a dialog with a number of tabs will appear The fields in the project tab speak for themselves Once doxygen has finished the Destination directory is where to look for the results Doxygen will put each output format in a separate sub directory The mode tab allows you to select how doxygen will look at your sources The default is to only look for things that have been documented You can also select how doxygen should present the results The latter does not affect the way doxygen parses your source code You can select one or more of the output formats that doxygen should produce For HTML and LaTeX there are additional options Doxygen can produce a number of diagrams Using the diagrams tab you can select which ones to generate For most diagrams the dot tool of the GraphViz package is needed if you use the binary p
69. output If you want to fine tune the way the output looks doxygen allows you generate default style sheet header and footer files that you can edit afterwards e For HTML output you can generate the default header file see HTML_HEADER the default footer see HTML_FOOTER and the default style sheet see HTML_STYLESHEET using the following command doxygen w html header html footer html stylesheet css lt config_file gt The config_file is optional When omitted doxygen will search for a file named Doxyfile and process that When this is also not found it will used the default settings For LaTeX output you can generate the first part of refman tex see LATEX_HEADER and the style sheet included by that header normally doxygen st y using 88 Doxygen usage doxygen w latex header tex doxygen sty If you need non default options for instance to use pdflatex you need to make a config file with those options set correctly and then specify that config file as the third argument For RTF output you can generate the default style sheet file see RTF_STYLESHEET_ FILE using doxygen w rtf rtfstyle cfg Warning When using a custom header you are responsible for the proper inclusion of any scripts and style sheets that doxygen needs which is dependent on the configuration options and may changes when upgrading to a new doxygen release Note If you do not want documentation for each item inside the configuration fil
70. preprocessor like __ cplusplus have to be defined by hand with doxygen s parser this is done because these defines are often platform compiler specific In some cases you may want to substitute a macro name or function by something else without exposing the result to further macro substitution You can do this but using the operator instead of As an example suppose we have the following piece of code Generated by Doxygen 57 define QList QListT class OListT Then the only way to get doxygen interpret this as a class definition for class QList is to define PREDEFINED QListT QList Here is an example provided by Valter Minute and Reyes Ponce that helps doxygen to wade through the boilerplate code in Microsoft s ATL amp MFC libraries PREDEFINED DECLARE_INTERFACE name class name STDMETHOD result name virtual result name PURE 0 THIS_ THIS DECLARE_REGISTRY_RESOURCEID DECLARE_PROTECT_FINAL_CONSTRUCT DECLARE_AGGREGATABLE Class DECLARE_REGISTRY_RESOURCEID Id DECLARE_MESSAGE_MAP BEGIN_MESSAGE_MAP x END_MESSAGE_MAP x BEGIN_COM_MAP END_COM_MAP x BEGIN_PROP_MAP x END_PROP_MAP x BEGIN_MSG_MAP x END_MSG_MAP BEGIN_PROPERTY_MAP x END_PROPERTY_MAP x BEGIN_OBJECT_MAP x END_OBJECT_MAP x DECLARE_VIEW_STATUS STDMETHOD a HRESULT a ATL_NO_VTABLE _
71. presented in which order and to some extent also how information is presented The layout file is an XML file The default layout can be generated by doxygen using the following command doxygen 1 optionally the name of the layout file can be specified if omitted DoxygenLayout xml will be used The next step is to mention the layout file in the config file LAYOUT_FILE DoxygenLayout xml To change the layout all you need to do is edit the layout file The toplevel structure of the file looks as follows lt doxygenlayout version 1 0 gt lt navindex gt lt navindex gt lt class gt lt class gt lt namespace gt lt namespace gt lt file gt lt file gt lt group gt lt group gt lt directory gt lt directory gt lt doxygenlayout gt The root element of the XML file is doxygenlayout it has an attribute named version which will be used in the future to cope with changes that are not backward compatible The first section identified by the navindex element represents the layout of the navigation tabs displayed at the top of each HTML page At the same time it also controls the items in the navigation tree in case GENERATE_TR EEVIEW is enabled Each tab is represented by a tab element in the XML file You can hide tabs by setting the visible attribute to no You can also override the default title of a tab by specifying it as the value of the title attribute If the title field is the empty string
72. respect to the compiler Because of that it may lie sometimes about the necessary base class The most obsolete language translators would lead to implementation of too complicated adapters Because of that doxygen developers may decide to derive such translators from the TranslatorEnglish class which is by definition always up to date When doing so all the missing methods will be replaced by the English translation This means that not Generated by Doxygen 178 Internationalization implemented methods will always return the English result Such translators are marked using word obsolete You should read it really obsolete No guess about the last update can be done Often it is possible to construct better result from the obsolete methods Because of that the translator adapter classes should be used if possible On the other hand implementation of adapters for really obsolete translators brings too much maintenance and run time overhead Generated by Doxygen Index 155 155 154 amp 154 155 lt 155 gt 155 154 155 MS 155 Va 144 addindex 138 addtogroup 116 129 anchor 138 arg 145 attention 129 author 129 authors 130 b 145 brief 130 bug 130 c 145 callergraph 117 callgraph 117 category 117 cite 139 class 118 code 146 cond 130 copydoc 146 copyright 134 date 131 def 118 defgroup 118 deprecated 131 de
73. sizeindication can be either width or height The size should be a valid size specifier in lATFX for example 10cm or 6in or a symbolic width like textwidth Here is example of a comment block x Here is a snapshot of my new application image html application Jpg image latex application eps My application width 10cm And this is an example of how the relevant part of the configuration file may look IMAGE_PATH my_image_dir Warning The image format for HTML is limited to what your browser supports For IAT X the image format must be Encapsulated PostScript eps Doxygen does not check if the image is in the correct format So you have to make sure this is the case 21 141 latexonly Starts a block of text that will be verbatim included in the generated IATEX documentation only The block ends with a endlatexonly command This command can be used to include IATEX code that is too complex for doxygen i e images formulas special characters You can use the htmlonly and endhtmlonly pair to provide a proper HTML alternative Note environment variables like HOME are resolved inside a IATEX only block See also section rtfonly section xmlonly section manonly and section htmlonly 21 142 Amanonly Starts a block of text that will be verbatim included in the generated MAN documentation only The block ends with a endmanonly command This command can be used to include groff code directly
74. supports Dynamic HTML and Javascript enabled 2 3 2 LaTeX output The generated IATEX documentation must first be compiled by a IATEX compiler I use a recent teTeX distribution for Linux and MacOSX and MikTex for Windows To simplify the process of compiling the generated documentation doxygen writes a Makefile into the Latex directory on the Windows platform also a make bat batch file is generated The contents and targets in the Makefile depend on the setting of USE_PDFLATEX If it is disabled set to NO then typing make in the Latex directory a dvi file called refman dvi will be generated This file can then be viewed using xdvi or converted into a PostScript file refman ps by typing make ps this requires dvips To put 2 pages on one physical page use make ps_2on1 instead The resulting PostScript file can be send to a PostScript printer If you do not have a PostScript printer you can try to use ghostscript to convert PostScript into something your printer understands Conversion to PDF is also possible if you have installed the ghostscript interpreter just type make pdf ormake pdf_2on1 To get the best results for PDF output you should set the PDF_HYPERLINKS and USE_PDFLATEX tags to YES In this case the Makefile will only contain a target to build refman pdf directly 2 3 3 RTF output Doxygen combines the RTF output to a single file called refman rtf This file is optimized for importing into the Microsoft Word Certa
75. text tags which will be replaced by the file and line number from which the warning originated and the warning text WARN_LOGFILE The WARN_LOGFILE tag can be used to specify a file to which warning and error messages should be written If left blank the output is written to stderr Generated by Doxygen 100 Configuration 20 5 Input related options INPUT The INPUT tag is used to specify the files and or directories that contain documented source files You may enter file names like my file cpp or directories like usr src myproject Separate the files or directories with spaces Note If this tag is empty the current directory is searched INPUT_ENCODING This tag can be used to specify the character encoding of the source files that doxygen parses Internally doxygen uses the UTF 8 encoding which is also the default input encoding Doxygen uses libiconv or the iconv built into libc for the transcoding See the libiconv documentation for the list of possible encodings FILE PATTERNS Ifthe value of the INPUT tag contains directories you can use the FILE_PATTERNS tag to specify one or more wildcard patterns like cpp and h to filter out the source files in the directories If left blank the following patterns are tested c cc CXX cpp C d java ii ixx 1pp itt inl h hh hxx hpp h idl odl cs php php3 inc m mm dox py f90 f vhd vhdl RECURSIVE The RE
76. the configuration file In the case above doxygen will then read both statements i e static CONST_STRING version static CONST_STRING version U2 4 lxx In case you want to expand the CONST_STRING macro you should set the MACRO_EXPANSION tag in the config file to YES Then the result after preprocessing becomes define VERSION define CONST_STRING static const char version 1 xx Note that doxygen will now expand all macro definitions recursively if needed This is often too much Therefore doxygen also allows you to expand only those defines that you explicitly specify For this you have to set the EXPAND_ONLY_PREDEF tag to YES and specify the macro definitions after the PREDEFINED or EXPAND_AS _DEFINED tag A typically example where some help from the preprocessor is needed is when dealing with Microsofts __ declspec language extension Here is an example function extern C void __declspec dllexport ErrorMsg String aMessage 56 Preprocessing When nothing is done doxygen will be confused and see _ declspec as some sort of function To help doxygen one typically uses the following preprocessor settings ENABLE_PREPROCESSING YES MACRO_EXPANSION YES EXPAND_ONLY_PREDEF YES PREDEFINED __declspec x This will make sure the __declspec dllexport is removed before doxygen parses the source code For a more complex example suppose you have the following obfuscated code fragment of a
77. times more traffic from Google than from Yahoo or MSN google http google com Google yahoo http search yahoo com Yahoo Search msn http search msn com MSN Search Link definitions will not be visible in the output Like for inline links doxygen also supports ref inside a link definition myclass ref MyClass My class 4 1 10 Images Markdown syntax for images is similar to that for links The only difference is an additional before the link text Examples Caption text path to img jpg Caption text path to img jpg Image title Caption text img def img def img def path to img jpg Optional Title Also here you can use ref to link to an image Caption text ref image png img def img def ref image png Caption text The caption text is optional Generated by Doxygen 4 2 Markdown Extensions 37 4 1 11 Automatic Linking To create a link to an URL or e mail address Markdown supports the following syntax lt http www example com gt lt address example com gt Note that doxygen will also produce the links without the angle brackets 4 2 Markdown Extensions 4 2 1 Table of Contents Doxygen supports a special link marker TOC which can be placed in a page to produce a table of contents at the start of the page listing all sections Note that using TOC is the same as using a tableofcontents command 4 2 2 Tables Of th
78. to NO the default the class list will be sorted only by class name not including the namespace part Generated by Doxygen 98 Configuration Note This option is not very useful if HIDE_SCOPE_NAMES is set to YES This option applies only to the class list not to the alphabetical list SORT_MEMBERS_CTORS_1ST Ifthe SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the brief and detailed documentation of class members so that constructors and destructors are listed first If set to NO the default the constructors will appear in the respective orders defined by SORT_MEMBER_ DOCS and SORT_BRIEF_DOCS Note If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief member documentation If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting detailed member documentation GENERATE_DEPRECATEDLIST The GENERATE_DEPRECATEDLIST tag can be used to enable YES or dis able NO the deprecated list This list is created by putting deprecated commands in the documentation STRICT_PROTO_MATCHING If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper type resolution of all parameters of a function it will reject a match between the prototype and the implementation of a member function even if there is only one candidate or it is obvious which candidate to choose by doing a simple string match By d
79. you change the font size after a successful doxygen run you need to manually remove any form_x png images from the HTML output directory to force them to be regenerated FORMULA TRANSPARENT Use the FORMULA _TRANPARENT tag to determine whether or not the images gen erated for formulas are transparent PNGs Transparent PNGs are not supported properly for IE 6 0 but are supported on all modern browsers Note that when changing this option you need to delete any form_ png files in the HTML output before the changes have effect USE_MATHJAX Enable the USE_MATHJAX option to render LaTeX formulas using MathJax see http www math7jax org which uses client side Javascript for the rendering instead of using prerendered bitmaps Use this if you do not have LaTeX installed or if you want to formulas look prettier in the HTML output When enabled you may also need to install MathJax separately and configure the path to it using the MATHJAX_RELPATH option MATHJAX_RELPATH When MathJax is enabled you need to specify the location relative to the HTML output directory using the MATHJAX_RELPATH option The destination directory should contain the MathJax js script For instance if the mathjax directory is located at the same level as the HTML output directory then MATHJAX_RELPATH should be mathjax The default value points to the MathJax Content Delivery Network so you can quickly see the result without installing MathJax However it is stron
80. 0 2 Project related options 59 59 59 59 59 60 62 63 65 67 67 67 67 68 68 69 71 73 73 73 74 75 77 81 83 85 87 87 89 Generated by Doxygen 6 CONTENTS 203 Bullelirelaisd OplIONS 2 ee Pb PHA A PENG RP hee L AS ws 96 20 4 Options related to warning and progress messages 2 e e e ee es 99 205 Inpulrelatedioplons 6 catas a ara be ee Be eo a ep A we ae 100 20 6 Source browsing related options o o oao oa e e e 101 20 7 Alphabetical index COMMONS cosmo a a A AE ae ee Be 102 208 PIMC rated OPUONS coman aa a A A A A ae 102 20 9 LaTeX related options i c 06 6085 oso eread asma e eee ee 107 20 10 RIP Teale ORION ocus p oes pnas KO Re a Oe ee ae ek Be 108 20 11 Man page related options o oos ce 6 660062 ee be ORE ee ee a ee 108 20 12 XML related Options c c ecoute esa be bed bbw bee e eee be a 109 20 13 AUTOGEN DEP related options lt lt lt erre ee e 109 20 14 PERLMOD related OPNS o lt ac ean ee Ge ea a ee eh ee ee i 109 2015 Preprocessor PAE OPTIONS o o ca 2 2a aE ee A eee ke de 109 20 16 External teterence OPUIONS o s o c cct aon od a soea moa aa a E a ee ee ee a G 110 Se e i ed ee a e ee a ee a ee ee A ae ATE ge pe ee Bay E a 110 21 Special Commands 115 21 1 UMUGGUCIOM io a ee A ACE dow As Beda Sede a eA ee da 115 21 2 addtogroup lt name gt title 2 2 oo 116 US CANON e Sed ee OS ee a hed Se ee Ee ee a i ea 117 21 4 Acallergraph 2
81. 0000 20 9 FILE_PATTERNS 0000000 20 5 LATEX HIDE_INDICES 000 20 9 FILE_VERSION FILTER 20 3 LATEX_OUTPUT 0 000 0000 eee eee 20 9 FILTER_PATTERNS ooo 20 5 LATEX SOURCE_CODE 20 9 FILTER_SOURCE_FILES 20 5 LAYOUT FILE Lo 20 3 FILTER_SOURCE_PATTERNS 20 5 LOOKUP_CACHE_SIZE 000 20 2 FORCE_LOCAL_INCLUDES 20 3 MACRO_EXPANSION ooo 20 15 FORMULA FONTSIZE 20 8 MAKEINDEX_CMD_NAME 20 9 FORMULA_TRANSPARENT 20 8 MAN_EXTENSION 20 11 FULL_PATH_NAMES 00000 20 2 MANLLINKS 0 0 00 0000 cee ee eee 20 11 GENERATE_AUTOGEN DEF 20 13 MAN OUTPUT 00000 00s 20 11 GENERATE BUGLIST 00 0 20 3 MARKDOWN_SUPPORT 0000 20 2 GENERATE_CH oo 20 8 MATHJAX_EXTENSIONS 200004 20 8 GENERATE_DEPRECIATEDLIST 20 3 MATHJAX_RELPATH 0 0 00 000005 20 8 GENERATE_DOCSET 000 20 8 MAX_DOT_GRAPH_DEPTH 20 17 GENERATE_ECLIPSEHELP 20 8 MAX_INITIALIZER_LINES 000 20 3 GENERATE_HTML 00000 20 8 MSCFILE_DIRS 0 0000000 20 17 GENERATE_HTMLHELP 0 20 8 MSCGEN PATH 00 000000 ee 20 17 GENERATE_LATEX 0 0000 20 9 MULTILINE_CPP_IS BRIEF 20 2 GENERATE LEGEND 20 17 OPTIMIZE_FOR_FORT
82. 3 Doxygen specifics 39 By default the name and title of the page are derived from the file name If the file starts with a level 1 header however it is used as the title of the page If you specify a label for the header as shown here doxygen will use that as the page name If the label is called index or mainpage doxygen will put the documentation on the front page index html Here is an example of a file README md that will appear as the main page when processed by doxygen My Main Page fmainpage Documentation that will appear on the main page 4 3 2 Treatment of HTML blocks Markdown is quite strict in the way it processes block level HTML block level HTML elements e g lt div gt lt table gt lt pre gt lt p gt etc must be separated from surrounding content by blank lines and the start and end tags of the block should not be indented with tabs or spaces Doxygen does not have this requirement and will also process Markdown formatting inside such HTML blocks The only exception is lt pre gt blocks which are passed untouched handy for ASCII art Doxygen will not process Markdown formatting inside verbatim or code blocks and in other sections that need to be processed without changes for instance formulas or inline dot graphs 4 3 3 Code Block Indentation With Markdown any block that is indented by 4 spaces and 8 spaces inside lists is treated as a code block This indentation amount i
83. ANON_NSPACES 96 EXTRACT_LOCAL_CLASSES 96 Generated by Doxygen INDEX 181 EXTRACT_LOCAL_METHODS 97 EXTRACT_PRIVATE 96 EXTRACT_STATIC 96 features 85 FILE_PATTERNS 100 FILE_VERSION_FILTER 98 FILTER_PATTERNS 101 FILTER_SOURCE_ FILES 101 FILTER_SOURCE_PATTERNS 101 flex 7 FORCE_LOCAL_ INCLUDES 97 FORMULA_FONTSIZE 106 FORMULA_TRANSPARENT 106 FULL_PATH_NAMES 94 GENERATE_AUTOGEN_DEF 109 GENERATE_BUGLIST 98 GENERATE_CHI 105 GENERATE_DEPRECATEDLIST 98 GENERATE_DOCSET 104 GENERATE_ECLIPSEHELP 105 GENERATE_HTML 102 GENERATE_HTMLHELP 104 GENERATE_LATEX 107 GENERATE_LEGEND 112 GENERATE_MAN 108 GENERATE_PERLMOD 109 GENERATE_QHP 105 GENERATE_RTF 108 GENERATE_TAGFILE 110 GENERATE_TESTLIST 98 GENERATE_TODOLIST 98 GENERATE_TREEVIEW 106 GENERATE_XML 109 GPL 2 GRAPHICAL_HIERARCHY 112 GROUP_GRAPHS 111 HAVE_DOT 111 HHC_LOCATION 105 HIDE_FRIEND_COMPOUNDS 97 HIDE_IN_BODY_DOCS 97 HIDE_SCOPE_NAMES 97 HIDE_UNDOC_CLASSES 97 HIDE_UNDOC_MEMBERS 97 HIDE_UNDOC_RELATIONS 111 HTML_ALIGN_MEMBERS 104 HTML_COLOR_STYLE_HUE 104 HTML_COLORSTYLE_SAT 104 HTML_DYNAMIC_SECTIONS 104 HTML_EXTRA_FILES 103 HTML_FILE_EXTENSION 102 HTML_FOOTER 103 HTML_HEADER 102 HTML_OUTPUT 102 HTML_STYLESHEET 103 HTML_TIMESTAMP 104 IDL_PROPERTY_SUPPORT 95 IGNORE_PREFIX 102 IMAGE_PATH 100 INCLUDE_FILE_PATTERNS 110 INCLUDE_GRAPH 111 INCLUDE_PATH 110 INCLUDED_BY_GRAPH 111 INHERIT_DOCS 95
84. ATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output Note that which sources are shown also depends on other settings such as SOURCE_BROWSER 20 10 RTF related options GENERATE_RTF lf the GENERATE_RTF tag is set to YES doxygen will generate RTF output The RTF output is optimized for Word 97 and may not look too pretty with other readers editors RTF_OUTPUT The RTF_OUTPUT tag is used to specify where the RTF docs will be put If a relative path is entered the value of OUTPUT_DIRECTORY will be put in front of it If left blank rtf will be used as the default path COMPACT_RTF Ifthe COMPACT_RTF tag is set to YES doxygen generates more compact RTF documents This may be useful for small projects and may help to save some trees in general RTF_HYPERLINKS Ifthe RTF_HYPERLINKS tag is set to YES the RTF that is generated will contain hyperlink fields The RTF file will contain links just like the HTML output instead of page references This makes the output suitable for online browsing using Word or some other Word compatible reader that support those fields note WordPad write and others do not support links RTF_STYLESHEET_FILE Load stylesheet definitions from file Syntax is similar to doxygen s config file i e a series of assignments You only have to provide replacements missing definitions are set to their default value
85. C style comments with XML markup Petr Prikryl for coordinating the internationalization support All language maintainers for providing transla tions into many languages e The band Porcupine Tree for providing hours of great music to listen to while coding many many others for suggestions patches and bug reports Generated by Doxygen CONTENTS Generated by Doxygen Part User Manual Chapter 1 Installation First go to the download page to get the latest distribution if you did not downloaded doxygen already 1 1 Compiling from source on UNIX If you downloaded the source distribution you need at least the following to build the executable The GNU tools flex bison and GNU make and strip e In order to generate a Makefile for your platform you need per1 The configure script assume the availability of standard UNIX tools such as sed date find uname mv cp cat echo tr cd and rm To take full advantage of doxygen s features the following additional tools should be installed Qt Software s GUI toolkit Ot version 4 3 or higher This is needed to build the GUI front end doxywizard A TEX distribution for instance teTeX 1 0 This is needed for generating LaTeX Postscript and PDF output e the Graph visualization toolkit version 1 8 10 or higher Needed for the include dependency graphs the graphical inheritance graphs and the collaboration graphs If you compile graphviz yourself
86. CURSIVE tag can be used to specify whether or not subdirectories should be searched for input files as well Possible values are YES and NO If left blank NO is used EXCLUDE The EXCLUDE tag can be used to specify files and or directories that should be excluded from the IN PUT source files This way you can easily exclude a subdirectory from a directory tree whose root is specified with the INPUT tag Note that relative paths are relative to the directory from which doxygen is run EXCLUDE_SYMLINKS The EXCLUDE_SYMLINKS tag can be used to select whether or not files or directories that are symbolic links a Unix file system feature are excluded from the input EXCLUDE_PATTERNS If the value of the INPUT tag contains directories you can use the EXCLUDE_PATTE RNS tag to specify one or more wildcard patterns to exclude certain files from those directories EXCLUDE_SYMBOLS The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names names paces classes functions etc that should be excluded from the output The symbol name can be a fully qualified name a word or if the wildcard x is used a substring Examples ANamespace AClass AClass ANamespace ANamespace Test Note that the wildcards are matched against the file with absolute path so to exclude all test directories use the pattern x test x EXAMPLE_PATH The EXAMPLE_PATH tag can be used to specify one or mor
87. Details x Nvar int errno brief Contains the last error code warning Not thread safe x fn int open const char pathname int flags brief Opens a file descriptor param pathname The name of the descriptor param flags Opening flags x x fn int close int fd brief Closes the file descriptor a fd param fd The descriptor to close x x fn size_t write int fd const char buf size_t count brief Writes a count bytes from a buf to the filedescriptor a fd param fd The descriptor to write to param buf The data buffer to write param count The number of bytes to write x fn int read int fd char buf size_t count brief Read bytes from a file descriptor param fd The descriptor to read from param buf The buffer to read into param count The number of bytes to read define MAX a b a gt b a b typedef unsigned int UINT32 int errno int open const char x int int close int size_t write int const char size_t int read int char size_t Because each comment block in the example above contains a structural command all the comment blocks could be moved to another location or input file the source file for instance without affecting the generated documentation The disadvantage of this approach is that prototypes are duplicated so all changes have to be made twice Because of this you should first consider if this is really needed and avoid structur
88. Documenting the sources 17 2 4 Step 3 Documenting the sources Although documenting the sources is presented as step 3 in a new project this should of course be step 1 Here assume you already have some code and you want doxygen to generate a nice document describing the API and maybe the internals and some related design documentation as well If the EXTRACT_ALL option is set to NO in the configuration file the default then doxygen will only generate documentation for documented entities So how do you document these For members classes and namespaces there are basically two options 1 Place a special documentation block in front of the declaration or definition of the member class or names pace For file class and namespace members it is also allowed to place the documentation directly after the member See section Special comment blocks to learn more about special documentation blocks 2 Place a special documentation block somewhere else another file or another location and put a structural command in the documentation block A structural command links a documentation block to a certain entity that can be documented e g a member class namespace or file See section Documentation at other places to learn more about structural commands The advantage of the first option is that you do not have to repeat the name of the entity Files can only be documented using the second option since there is no way to put a documen
89. ER INPUT FILE PATTERNS RECURSIVE EXCLUDE_PATTERNS ALPHABETICAL_INDEX COLS_IN_ALPHA_INDEX IGNORE_PREFIX ENABLE_PREPROCESSING MACRO_EXPANSION INCLUDE_PATH PREDEFINED EXPAND_ONLY_PREDEF EXPAND_AS_DEFINED eal ES ES ES QTDIR src Cpp h qx x doc ES ES ES ES QTDIR include Q_PROPERTY x Q_OVERRIDE x Q_EXPORT Q_ENUMS x wMKKOWK K ANKK KN QT_STATIC_CONST static const _WS_X11_ INCLUDE_MENUITEM_DEF YES Q_OBJECT_FAKE Q_OBJECT ACTIVATE_SIGNAL_WITH_PARAM Q_VARIANT_AS codec cpp moc_ compat 3rdparty Here doxygen s preprocessor is used to substitute some macro names that are normally substituted by the C preprocessor but without doing full macro expansion Generated by Doxygen Chapter 21 Special Commands 21 1 Introduction All commands in the documentation start with a backslash or an at sign If you prefer you can replace all commands starting with a backslash below by their counterparts that start with an at sign Some commands have one or more arguments Each argument has a certain range e If lt sharp gt braces are used the argument is a single word If round braces are used the argument extends until the end of the line on which the command was found If curly braces are used the argument extends until the next paragraph Paragraphs are delimited by a blank line or by a section indicator If in addit
90. ES then this tag can be used to specify a list of macro names that should be expanded The macro definition that is found in the sources will be used Use the PREDEFINED tag if you want to use a different macro definition SKIP_FUNCTION_MACROS If the SKIP_FUNCTION_MACROS tag is set to YES the default then doxygen s preprocessor will remove all function like macros that are alone on a line have an all uppercase name and do not end with a semicolon Such function macros are typically used for boiler plate code and will confuse the parser if not removed 20 16 External reference options TAGFILES The TAGFILES tag can be used to specify one or more tag files See Linking to external documentation for more information about the use of tag files Note Each tag file must have a unique name where the name does not include the path If a tag file is not located in the directory in which doxygen is run you must also specify the path to the tagfile here GENERATE_TAGFILE When afile name is specified after GENERATE_TAGF ILE doxygen will create a tag file that is based on the input files it reads See section Linking to external documentation for more information about the usage of tag files ALLEXTERNALS If the ALLEXTERNALS tag is set to YES all external class will be listed in the class index If set to NO only the inherited external classes will be listed EXTERNAL_GROUPS If the EXTERNAL_GRO
91. FORTRAN Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran sources Doxygen will then generate output that is tailored for Fortran OPTIMIZE_OUTPUT_VHDL Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL sources Doxygen will then generate output that is tailored for VHDL EXTENSION_MAPPING Doxygen selects the parser to use depending on the extension of the files it parses With this tag you can assign which parser to use for a given extension Doxygen has a built in mapping but you can override or extend it using this tag The format is ext language where ext is a file extension and language is one of the parsers supported by doxygen IDL Java Javascript C C C D PHP Objective C Python Fortran VHDL For instance to make doxygen treat inc files as Fortran files default is PHP and f files as C default is Fortran use inc Fortran f C Generated by Doxygen 96 Configuration SUBGROUPING Set the SUBGROUPING tag to YES the default to allow class member groups of the same type for instance a group of public functions to be put as a subgroup of that type e g under the Public Functions section Set itto NO to prevent subgrouping Alternatively this can be done per class using the nosubgrouping command INLINE_GROUPED_CLASSES When the INLINE_GROUPED_CLASSES tag is set to YES classes structs and unions are shown inside the group in which the
92. GENERATE_TREEVIEW NO 12 1 3 Dynamic Content To make the HTML output more interactive doxygen provides a number of options that are disabled by default e enabling HTML_DYNAMIC_SECTIONS will make doxygen hide certain content like graphs in the HTML by default and let the reader expand these sections on request enabling USE_INLINE_TREES will make some tree structures in the output dynamically expandable enabling HAVE_DOT along with INTERACTIVE_SVG while setting DOT_IMAGE_FORMAT to svg will make doxygen produce SVG images that will allow the user to zoom and pan this only happens when the size of the images exceeds a certain size 12 1 4 Header Footer and Stylesheet changes To tweak things like fonts or colors margins or other look amp feel aspects of the HTML output in detail you can create a different cascading style sheet You can also let doxygen use a custom header and footer for each HTML page it generates for instance to make the output conform to the style used on the rest of your web site To do this first run doxygen as follows doxygen w html header html footer html customdoxygen css This will create 3 files header html is a HTML fragment which doxygen normally uses to start a HTML page Note that the fragment ends with a body tag and that is contains a couple of commands of the form word These will be replaced by doxygen on the fly e footer html is a HTML fragment which doxygen normally uses to end a
93. HTMLHELP in the config file then you need the Microsoft HTML help workshop You can download it from Microsoft If you want to produce Qt Compressed Help files see QHG_LOCATION in the config file then you need ghelp generator which is part of Qt You can download Qt from Ot Software Downloads In order to generate PDF output or use scientific formulas you will also need to install LaTeX and Ghostscript For LaTeX a number of distributions exists Popular ones that should work with doxygen are Mik Tex and XemTex Ghostscript can be downloaded from Sourceforge After installing LaTeX and Ghostscript you ll need to make sure the tools latex exe pdflatex exe and gswin32c exe are present in the search path of a command box Follow these instructions if you are unsure and run the commands from a command box to verify it works Generated by Doxygen 12 Installation 1 6 Tools used to develop doxygen Doxygen was developed and tested under Linux amp MacOSX using the following open source tools GCC version 3 3 6 Linux and 4 0 1 MacOSX GNU flex version 2 5 33 Linux and 2 5 4 MacOSX GNU bison version 1 75 GNU make version 3 80 Perl version 5 8 1 VIM version 6 2 Firefox 1 5 Trolltech s tmake version 1 3 included in the distribution teTeX version 2 0 2 CVS 1 12 12 Generated by Doxygen Chapter 2 Getting Started The executable doxygen is the main program that parses the sources and generates th
94. I frontend Doxywizard to ease editing the options and run doxygen The GUI is available on Windows Linux and MacOSX Automatically generates class and collaboration diagrams in HTML as clickable image maps and IATEX as Encapsulated PostScript images Uses the dot tool of the Graphviz tool kit to generate include dependency graphs collaboration diagrams call graphs directory structure graphs and graphical class hierarchy graphs Allows grouping of entities in modules and creating a hierarchy of modules Flexible comment placement Allows you to put documentation in the header file before the declaration of an entity source file before the definition of an entity or in a separate file Generates a list of all members of a class including any inherited members along with their protection level Outputs documentation in on line format XHTML and UNIX man page and off line format ATEX and RTF simultaneously any of these can be disabled if desired All formats are optimized for ease of reading Furthermore compressed HTML can be generated from HTML output using Microsoft s HTML Help Work shop Windows only and PDF can be generated from the IATEX output Support for various third party help formats including HTML Help docsets Qt Help and eclipse help Includes a full C preprocessor to allow proper parsing of conditional code fragments and to allow expansion of all or part of macros definitions Automatically detects pu
95. IATEX generator starts a new section in the chapter Page documentation Example page pagel A documentation page tableofcontents Leading text section sec An example section This page contains the subsections ref subsectionl and ref subsection2 For more info see page ref page2 subsection subsectionl The first subsection Text subsection subsection2 The second subsection More text page page2 Another page Even more info Note The lt name gt argument consists of a combination of letters and number digits If you wish to use upper case letters e g MYPAGE1 or mixed case letters e g MyPage1 in the lt name gt argument you should set CASE_SENSE_NAMES to YES However this is advisable only if your file system is case sensitive Otherwise and for better portability you should use all lower case letters e g mypage1 for lt name gt in all references to the page See also section section section subsection and section ref Generated by Doxygen 126 Special Commands 21 30 private Indicates that the member documented in the comment block is private e should only be accessed by other members in the same class Note that Doxygen automatically detects the protection level of members in object oriented languages This com mand is intended for use only when the language does not support the concept of protection level natively e g C PHP 4
96. IP_THIS E n in the config file then all blocks should be skipped by Doxygen as long as PREPROCESSING Y How can change what is after the include in the class documentation In most cases you can use STRIP_FROM_INC_PATH to strip a user defined part of a path You can also document your class as follows x class MyClassName include h path include h Docs for MyClassName x To make doxygen put include lt path include h gt in the documentation of the class MyClassName regardless of the name of the actual header file in which the definition of MyClassName is contained If you want doxygen to show that the include file should be included using quotes instead of angle brackets you should type x class MyClassName myhdr h path myhdr h Docs for MyClassName How can use tag files in combination with compressed HTML If you want to refer from one compressed HTML file a chm to another compressed HTML file called b chm the link in a chm must have the following format lt a href b chm file html gt Unfortunately this only works if both compressed HTML files are in the same directory As a result you must rename the generated index chm files for all projects into something unique and put all chm files in one directory Suppose you have a project a referring to a project b using tag file b tag then you could rename the index chm for project a into a chm and the ind
97. N 42h sa fal i ake ast pd e li ii 21 45 package oe eee 21 28 Nlntl 2 sia eat Bul oS Po we o a 21 108 WAP 2 juice wt Sar PA lew a aa a bee weal BA 21 46 NDAQE mer Saat a ee SA ek Rae ae Pane 21 29 verbatiri en DAN uoga arog Rese ce Het eh ecm Beret eek Gees 21 67 SONA ag ger ce Sages tis Mees EN Ie cen Ue ene paragraph 2 ee 21 100 verbinclude Sy Soe a see gee Se hee aah dp 21 109 NOANAM aon tosh ete aA ee he Aa baad wd 21 68 version A O A ES 21 08 NPOSE an cs aida dt pe Aa ein ale a 21 70 WaMing ararnar RIOT AO A 21 71 weakgroup 2 2 a 21 47 private Sak oo dei eed dd a need 21 30 xmionly Datta dee oun Seeley acc hats ak erate te es eats 21 148 privatesecton o o o o oo o oo oo 21 30 xrefitem oo 21 88 Wporoperty sarc mari oraina Bah Sa eee ed 21 32 PE ao shh Tose as et VE od ae Ee ee dhe 21 153 protected dais wa hel Be ee ak wa ears S 21 38 e ve ee 21 150 protectedsection 0000 0000s 21 33 A leg ae Ge a he wed GE ee E E a 21 149 protocol ad ae de ae Roe eh al ya 21 35 NA a a A de wget 21 152 NplibllC lt dado E dio sd ed IN ed ves Sa dee bbe ee ame oad 21 151 publicsection o ooo 21 36 Ni e da ela ea 21 155 A Set once AE ree Sas pond Gg a Seen 21 94 Noh cee E ae st 21 156 elated aeaii aah Bo ee wees a 21 39 NF a eek ase a RACE Rated BABS gas Hed eee BCPA 21 154 WelateS 4 Av a ia pea eo Se eke amp 21 38 Nek tek Rind E ak are Bua aa 21 157 elatedalso i T caina la se a Ak
98. NINGS YES INPUT examples examples doc src FILE PATTERNS x CC h INCLUDE_PATH examples TAGFILES gt tag PERL_PATH usr bin perl SEARCHENGINE YES To regenerate the Qt 1 44 documentation from the sources you could use the following config file PROJECT_NAME Qt OUTPUT_DIRECTORY gqt_docs HIDE_UNDOC_MEMBERS YES HIDE_UNDOC_CLASSES ES ENABLE_PREPROCESSING ES MACRO_EXPANSION ES EXPAND_ONLY_PREDEF ES SEARCH_INCLUDES YES FULL_PATH_NAMES YES STRIP_FROM_PATH OTDIR PREDEFINED USE_TEMPLATECLASS Q_EXPORT x Y Y Y Y Y U QArrayT QArray QListT QList QDictT QDict QQueueT QQueue QVectorT QVector Q Q Q Q Q Q Q Q Q Q PtrDictT QPtrDict ntDictT QIntDict StackT QStack DictIteratorT QDictIterator ListIteratorT QListIterator CacheT QCache CachelIteratorT QCachelIterator ntCacheT QIntCache ntCachelteratorT QIntCachelterator ntDictIteratorT QIntDictIterator QPtrDictIteratorT QPtrDictIterator INPUT QTDIR doc QTDIR src widgets QTDIR src kernel Y QTDIR src dialogs QTDIR src tools FILE_PATTERNS cpp h qx doc INCLUDE_PATH S OTDIR include RECURSIVE YES For the Qt 2 1 sources recommend to use the following settings PROJECT_NAME Qt Generated by Doxygen 114 Configuration PROJECT_NUMBER HIDE_UNDOC_MEMBERS HIDE_UNDOC_CLASSES SOURCE_BROWS
99. NLY_PREDEF If the EXPAND_ONLY_PREDEF and MACRO_EXPANSTON tags are both set to YES then the macro expansion is limited to the macros specified with the PREDEFINED and EXPAND_AS_DE FINED tags Generated by Doxygen 110 Configuration SEARCH_INCLUDES If the SEARCH_INCLUDES tag is set to YES the default the includes files in the INCL UDE_PATH see below will be searched if a include is found INCLUDE_PATH The INCLUDE_PATH tag can be used to specify one or more directories that contain include files that are not input files but should be processed by the preprocessor INCLUDE_FILE_PATTERNS You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wild card patterns like h and hpp to filter out the header files in the directories If left blank the patterns specified with FILE_PATTERNS will be used PREDEFINED The PREDEFINED tag can be used to specify one or more macro names that are defined before the preprocessor is started similar to the D option of gcc The argument of the tag is a list of macros of the form name or name definition no spaces If the definition and the are omitted 1 is assumed To prevent a macro definition from being undefined via undef or recursively expanded use the operator instead of the operator EXPAND_AS DEFINED If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to Y
100. RAN 20 2 GENERATE MAN 20 11 OPTIMIZE_OUTPUT_FORC 20 2 GENERATE_PERLMOD 20 14 OPTIMIZE_LOUTPUTJAVA 000 20 2 GENERATE_QHP 00000 20 8 OPTIMIZE OUTPUT_VHDL 0 20 2 GENERATE_RTF o 0 ee 20 10 OUTPUT_DIRECTORY 0 0 20 2 GENERATE_TAGFILE 000 20 16 OUTPUT LANGUAGE 20 2 GENERATE_TESTLIST 0000 20 3 PAPER TYPE 00 0000 cee eee 20 9 GENERATE_TODOLIST 00 0 20 3 PDF_HYPERLINKS 00 000008 20 9 GENERATE_TREEVIEW 000 20 8 PERLPATH 00000 cece eee eee 20 16 GENERATE_XML 0000 20 12 PERLMOD_LATEX 00000 20 14 GRAPHICAL HIERARCHY 20 17 PERLMOD_MAKEVAR_PREFIX 20 14 GROUP_GRAPHS 0000 20 417 PERLMOD_PRETTY 00 20 14 HAVE DOT o 20 17 PREDEFINED 00000 20 15 HHC LOCATION o 20 8 PROJECTZBRIEF 000000000 20 2 HIDE_FRIEND_COMPOUNDS 20 3 PROJECTLOGO 0 0 000 20 2 HIDE_IN BODY_DOCS 00 20 3 PROJECT NAME 000000008 20 2 HIDE_SCOPE_NAMES 00 20 3 PROJECT NUMBER 00004 20 2 HIDE_UNDOC_CLASSES 20 3 QCH FILE 20 8 HIDE_UNDOC_MEMBERS 20 3 QHG_LOCATION ooo 20 8 HIDE_UNDOC_RELATIONS 20 17 QHP_CUST_FILTER_ATTRS
101. RR ROKR KR KR RR KR kk a J kk caa text ee ee RRA RAR RRA KR RRA RARA RRA RARA RARA RARA AS note the 2 slashes to end the normal comment block and start a special comment block or AAA AAA AAA AAA AAA AAA AAA AAA AAA AAA 4 text vos AAA AAA AAA AAA AAA AAA AAA AAA For the brief description there are also several possibilities One could use the brief command with one of the above comment blocks This command ends at the end of a paragraph so the detailed description follows after an empty line Here is an example Norief Brief description Brief description continued Detailed description starts here If JAVADOC_AUTOBRIEF is set to YES in the configuration file then using JavaDoc style comment blocks will automatically start a brief description which ends at the first dot followed by a space or new line Here is an example x x Brief description which ends at this dot Details follow here The option has the same effect for multi line special C comments Generated by Doxygen 3 1 Special comment blocks 21 Brief description which ends at this dot Details follow here 3 A third option is to use a special C style comment which does not span more than one line Here are two examples Brief description x Detailed description or Brief description Detailed description starts here Note the blank line in the last exampl
102. S INCLUDE_GRAPH and HAV E_DOT tags are set to YES then doxygen will generate a graph for each documented file showing the direct and indirect include dependencies of the file with other documented files INCLUDED_BY_GRAPH Ifthe ENABLE _PREPROCESSING SEARCH_INCLUDES INCLUDED_BY_GRAPH and HAVE_DOT tags are set to YES then doxygen will generate a graph for each documented header file showing the documented files that directly or indirectly include this file CALL_GRAPH lf the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will generate a call de pendency graph for every global function or class method Note that enabling this option will significantly increase the time of a run So in most cases it will be better to enable call graphs for selected functions only using the callgraph command Generated by Doxygen 112 Configuration CALLER_GRAPH Ifthe CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will generate a caller dependency graph for every global function or class method Note that enabling this option will significantly increase the time of arun So in most cases it will be better to enable caller graphs for selected functions only using the callergraph command GRAPHICAL HIERARCHY If the GRAPHICAL HIERARCHY and HAVE_DOT tags are set to YES then doxy gen will graphical hierarchy of all classes instead of a textual one DIRECTORY_GRAPH If
103. Searching Doxygen indexes your source code in various ways to make it easier to navigate and find what you are looking for There are also situations however where you want to search for something by keyword rather than browse for it HTML browsers by default have no search capabilities that work across multiple pages so either doxygen or external tools need to help to facilitate this feature Doxygen has 6 different ways to add searching to the HTML output each of which has its own advantages and disadvantages 1 Client side searching The easiest way to enable searching is to enable the built in client side search engine This engine is implemented using Javascript and DHTML only and runs entirely on the clients browser So no additional tooling is required to make it work To enable it set SEARCHENGINE to YES in the config file and make sure SERVER_BASED_SEARCH is set to NO An additional advantage of this method is that it provides live searching i e the search results are presented and adapted as you type This method also has its drawbacks it is limited to searching for symbols only It does not provide full text search capabilities and it does not scale well to very large projects then searching becomes very slow 2 Server side searching If you plan to put the HTML documentation on a web server and that web server has the capability to process PHP code then you can also use doxygen s built in server side search engine
104. TIC tag is set to YES all static members of a file will be included in the documentation EXTRACT_LOCAL CLASSES If the EXTRACT_LOCAL_CLASSES tag is set to YES classes and structs de fined locally in source files will be included in the documentation If set to NO only classes defined in header files are included Does not have any effect for Java sources EXTRACT ANON _NSPACES If this flag is set to YES the members of anonymous namespaces will be extracted and appear in the documentation as a namespace called anonymous_namespaceffile where file will be replaced with the base name of the file that contains the anonymous namespace By default anonymous namespace are hidden Generated by Doxygen 20 3 Build related options 97 EXTRACT_LOCAL METHODS This flag is only useful for Objective C code When set to YES local methods which are defined in the implementation section but not in the interface are included in the documentation If set to NO the default only methods in the interface are included HIDE_UNDOC_MEMBERS Ifthe HIDE_UNDOC_MEMBERS tag is set to YES doxygen will hide all undocumented members inside documented classes or files If set to NO the default these members will be included in the various overviews but no documentation section is generated This option has no effect if EXTRACT_ALL is enabled HIDE_UNDOC_CLASSES If the HIDE_UNDOC_CLASSESS tag is set to YES doxygen wil
105. The two instances of the description will be cross referenced Each test case in the test list will be preceded by a header that indicates the origin of the test case 21 83 throw lt exception object gt exception description Synonymous to exception see section exception Note the tag throws is a synonym for this tag See also section exception 21 84 throws lt exception object gt exception description Equivalent to throw 21 85 todo paragraph describing what is to be done Starts a paragraph where a TODO item is described The description will also add an item to a separate TODO list The two instances of the description will be cross referenced Each item in the TODO list will be preceded by a header that indicates the origin of the item 21 86 version version number Starts a paragraph where one or more version strings may be entered The paragraph will be indented The text of the paragraph has no special internal structure All visual enhancement commands may be used inside the Generated by Doxygen 138 Special Commands paragraph Multiple adjacent version commands will be joined into a single paragraph Each version description will start on a new line Alternatively one version command may mention several version strings The version command ends when a blank line or some other sectioning command is encountered See section author for an example 21 87 warning warning message
106. UPPORT 20 2 DOCSET_FEEDNAME 20 8 CALL GRAPH oo che wp Se aa dee we RE a dae Ge 20 17 DOCSET_PUBLISHER_ID 20 8 GALLER GRAPH car RBS e OR 20 17 DOCSET_PUBLISHER_NAME 20 8 CASE_SENSE_NAMES 20 3 DOT_CLEANUP o o ccocococococo ooo 20 17 CHMOFILE gt a gig a e a a a 20 8 DOT_FONTNAME o oo o 20 17 CHM_INDEX_ENCODING 20 8 DOT_FONTPATH 2 a ga Se a o a a 20 17 CITE BIBUFILES soi a a hi a 20 3 DOT_FONTSIZE o o o coo e 20 17 CLASS _DIAGRAMS 0 20 17 DOT_GRAPH_MAX_NODES 20 17 CLASS_GRAPH ooo oi o ta adua 20 17 DOT_IMAGE_FORMAT 20 17 COLLABORATION_GRAPH 20 17 DOT_MULTILTARGETS 2 20 17 COLS_IN_ALPHA_INDEX 0 20 7 DOT_NUM_THREADS 20 17 COMPACT_LATEX o o o ooo 20 9 DOT RATA 2 24 as ds ads e do 20 17 92 Configuration DOT_TRANSPARENT 20 47 HTML_QUIPUT oaaao aa 20 8 DOTFILE_DIRS 0 20 417 HTML_STYLESHEET 0 0 20 8 DOXYFILE_ENCODING 20 2 HTML_TIMESTAMP ooa a 20 8 ECLIPSELDOC ID 20 8 IDL_PROPERTY_SUPPORT 20 2 ENABLE_PREPROCESSING 20 15 IGNORE_PREFIX 00000 20 7 ENABLED_SECTIONS 00 20 3 IMAGE PATH 0 0 00000 eee ee eee 20 5 ENUM_VALUES PER_LLINE
107. UPS tag is set to YES all external groups will be listed in the mod ules index If set to NO only the current project s groups will be listed PERL_PATH The PERL_PATH should be the absolute path and name of the perl script interpreter i e the result of which perl 20 17 Dot options CLASS DIAGRAMS If the CLASS_DIAGRAMS tag is set to YES the default doxygen will generate a class diagram in HTML and IATEX for classes with base or super classes Setting the tag to NO turns the diagrams off Note that this option also works with HAVE_DOT disabled but it is recommended to install and use dot since it yields more powerful graphs MSCGEN_PATH You can define message sequence charts within doxygen comments using the msc command Doxygen will then run the mscgen tool to produce the chart and insert it in the documentation The MSCGEN_PATH tag allows you to specify the directory where the mscgen tool resides If left empty the tool is assumed to be found in the default search path Generated by Doxygen 20 17 Dot options 111 HAVE_DOT If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is available from the path This tool is part of Graphviz a graph visualization toolkit from AT amp T and Lucent Bell Labs The other options in this section have no effect if this option is set to NO the default DOT_NUM_THREADS The DOT_NUM_THREADS specifies the number of dot invocations doxygen is al
108. Use this command to emphasize words Example Typing this is a le really good example will result in the following text this is a really good example Equivalent to a and em To emphasize multiple words use lt em gt multiple words lt em gt Generated by Doxygen 21 124 lem lt word gt 149 21 124 lem lt word gt Displays the argument lt word gt in italics Use this command to emphasize words Example Typing this is a lem really good example will result in the following text this is a really good example Equivalent to a and e To emphasize multiple words use lt em gt multiple words lt em gt 21 125 endcode Ends a block of code See also section code 21 126 enddot Ends a blocks that was started with dot 21 127 lendmsc Ends a blocks that was started with msc 21 128 endhtmlonly Ends a block of text that was started with a htmlonly command See also section htmlonly 21 129 endlatexonly Ends a block of text that was started with a latexonly command See also section latexonly 21 130 lendmanonly Ends a block of text that was started with a manonly command Generated by Doxygen 150 Special Commands See also section manonly 21 131 lendrtfonly Ends a block of text that was started with a rtfonly command See also section rtfonly 21 132 lendverbatim Ends a block of text that was start
109. Xable doxyformat tex This file contains the LaTeX code that transforms the documentation from doxydocs tex into LaTeX text suitable to be LaTeX ed and presented to the user doxylatex template pl This Perl script uses DoxyModel pm to generate doxytemplate tex a TeX file defin ing default values for some macros doxytemplate tex is included by doxyformat tex to avoid the need of explicitly defining some macros doxylatex tex This is a very simple LaTeX document that loads some packages and includes doxyformat tex and doxydocs tex This document is LaTeX ed to produce the PDF and DVI documentation by the rules added to doxyrules make 25 2 1 Creation of PDF and DVI output To try this you need to have installed LaTeX PDFLaTeX and the packages used by doxylatex tex 1 Update your Doxyfile to the latest version using doxygen u Doxyfile 2 Set both GENERATE_PERLMOD and PERLMOD_LATEX tags to YES in your Doxyfile 3 Run Doxygen on your Doxyfile doxygen Doxyfile 4 A perlmod subdirectory should have appeared in your output directory Enter the perlmod subdirectory and run make pdf This should generate a doxylatex pdf with the documentation in PDF format 5 Run make dvi This should generate a doxylatex dvi with the documentation in DVI format Generated by Doxygen 25 3 Documentation format 171 25 3 Documentation format The Perl Module documentation generated by Doxygen is stored in DoxyDocs pm
110. YES will include the body of functions classes and enums directly into the documentation STRIP_CODE_COMMENTS Setting the STRIP_CODE_COMMENTS tag to YES the default will instruct doxygen to hide any special comment blocks from generated source code fragments Normal C and C comments will always remain visible REFERENCED_BY RELATION If the REFERENCED_BY_RELATION tag is set to YES then for each docu mented function all documented functions referencing it will be listed REFERENCES_RELATION If the REFERENCES_RELATION tag is set to YES then for each documented func tion all documented entities called used by that function will be listed REFERENCES_LINK_SOURCE If the REFERENCES_LINK_SOURCE tag is set to YES the default and SOU RCE_BROWSER tag is set to YES then the hyperlinks from functions in REFERENCES_RELATION and R EFERENCED_BY_RELATION lists will link to the source code Otherwise they will link to the documentation VERBATIM_HEADERS lf the VERBATIM_HEADERS tag is set the YES the default then doxygen will generate a verbatim copy of the header file for each class for which an include is specified Set to NO to disable this See also Section class USE_HTAGS If the USE_HTAGS tag is set to YES then the references to source code will point to the HTML generated by the htags 1 tool instead of doxygen built in source browser
111. _MEMBERS and BRIEF_MEMBER_DESC are set to NO the brief descriptions will be completely suppressed ABBREVIATE_BRIEF This tag implements a quasi intelligent brief description abbreviator that is used to form the text in various listings Each string in this list if found as the leading text of the brief description will be stripped from the text and the result after processing the whole list is used as the annotated text Otherwise the brief description is used as is If left blank the following values are used name is automatically replaced with the name of the entity The name class The name widget The name file is provides specifies contains represents a an the ALWAYS_DETAILED_SEC If the ALWAYS _DETAILED_SEC and REPEAT_BRIEF tags are both set to Y then doxygen will generate a detailed section even if there is only a brief description Gl wn INLINE_INHERITED_MEMB If the INLINE_INHERITED_MEMB tag is set to YES doxygen will show all inherited members of a class in the documentation of that class as if those members were ordinary class members Constructors destructors and assignment operators of the base classes will not be shown FULL_PATH_NAMES lf the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path before files name in the file list and in the header files If set to NO the shortest path that makes the file name un
112. a dais oh ae 21 75 NIMOE lt del atte ats 21 64 VOUAS 0 ra e e aio DA 21 76 NIMAgES cad ata al ade 21 140 retval o 21 77 implements e p e 22 fee de non RG ica 21 18 NEON la hilado E 21 146 inclide opio a 0 O te aS a od eed lata ba ee 21 78 Xincludelineno lt s e a a ee ee A SectiOn ii kei aa Wie ek EE E E EEN da G 21 97 NINGIDU ocho ee Da ag eae anne eee IO A Ed ra A aaa ee E 21 79 internal eee PUST O eed A Bact Wheres OE Gos oan E ek 21 80 invariant ee 21 65 Ashowinitializer 2 2 2 eee ee 21 42 Ninterfacee s 6 sacha araa a a RAYS oye ue 21 20 A Since Mate Ato a See 21 81 latexonly 24 sk Suda ba Be a ee A 21141 skip AN 21 105 ORERE ELE skipline ad Sah RR 21 106 Aja AAA ARA E E O A A E Ge A O 2 0 oa Fae heed gg Ee OR ee a 21 107 IK a Fah cara ce a OE Bee a ME ein Sea 21 93 SUCIA ee SS See ek Ged A 21 43 mainpage ee eles een e ras Sate Ga he ans clad Za aah dee ac eh 21 95 manonly gt aaas aaar a araar is NSUDSECHON u s gaa ak ke a ee ae eg 21 98 MeMb erof So a eas Sale oe ARR aw 21 23 subsubsection 21 99 o A a en en e tableofcontents o o occ aoc cia ca a a an 21 96 meele rre de aL ri rr Ae eels 21 82 ae AAA A UNO Sitios gatcrpse aaa chet de Mian det oan 21 83 eee eT ee A 7 h A E EE Mamespace o o o ee a E N 21 25 o m nosubgrouping Bie A ge ee One UNO 21 66 NIP ra ek a ity e 21 69 AA MyBedeh a4 oi tad a OG ae ie a ANA Voveriai 2 2 io wake KER i a Cae 21 27 UI A A ON 21145 UNIO
113. ackages for MacOSX this tool is already includea 90 Doxywizard usage Expert dialog The Expert dialog has a number of tab fields one for each section in the configuration file Each tab field contains a number of lines one for each configuration option in that section The kind of input widget depends on the type of the configuration option For each boolean option those options that are answered with YES or NO in the configuration file there is a check box For items taking one of a fixed set of values like OUTPUT_LANGUAGE a combo box is used e For items taking an integer value from a range a spinbox is used e For free form string type options there is a one line edit field e For options taking a lists of strings a one line edit field is available with a button to add this string to the list and a button to remove the selected string from the list There is also a x button that when pressed replaces the selected item in the list with the string entered in the edit field e For file and folder entries there are special buttons that start a file selection dialog The get additional information about the meaning of an option click on the Help button at the bottom right of the dialog and then on the item A tooltip with additional information will appear Menu options The GUI front end has a menu with a couple of useful items Open This is the same as the Load button in the main window
114. ain name style string e g com mycompany MyDocSet Doxygen will append docset to the name DOCSET_PUBLISHER_ID When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely iden tify the documentation publisher This should be a reverse domain name style string e g com mycompany MyDocSet documentation DOCSET_PUBLISHER_NAME The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher GENERATE _HTMLHELP If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three addi tional HTML index files index hhp index hhc and index hhk The index hhp is a project file that can be read by Microsoft s HTML Help Workshop on Windows The HTML Help Workshop contains a compiler that can convert all HTML output generated by doxygen into a single compiled HTML file chm Compiled HTML files are now used as the Windows 98 help format and will replace the old Windows help format hlp on all Windows platforms in the future Compressed HTML files also contain an index a table of contents and you can search for words in the documentation The HTML workshop also contains a viewer for compressed HTML files 7 CHM FILE Ifthe GENERATE_HTMLHELP tag is set to YES the CHM_FILE tag can be used to specify the file name of the resulting chm file You can add a path in front of the file if the result should not be written to the html output directory Generated
115. al commands if possible often receive examples that contain fn command in comment blocks which are place in front of a function This is clearly a case where the fn command is redundant and will only lead to problems 3 1 2 Comment blocks in Python For Python there is a standard way of documenting the code using so called documentation strings Such strings are stored in doc and can be retrieved at runtime Doxygen will extract such comments and assume they have to be represented in a preformatted way fGpackage docstring Documentation for this module More details def func Documentation for a function Generated by Doxygen 3 1 Special comment blocks 27 More details wy pass class PyClass Documentation for a class More details wo def __init__ self The constructor self _memVar 0 def PyMethod self Documentation for a method pass Note that in this case none of doxygen s special commands are supported There is also another way to document Python code using comments that start with These type of comment blocks are more in line with the way documentation blocks work for the other languages supported by doxygen and this also allows the use of special commands Here is the same example again but now using doxygen style comments package pyexample Documentation for this module More details Documentation for a function More details def f
116. ands 21 151 Languageld This command enables disables a language specific filter This can be used to put documentation for different language into one comment block and use the OUTPUT_LANGUAGE tag to filter out only a specific language Use language_id to enable output for a specific language only and to enable output for all languages this is also the default mode Example english This is english dutch Dit is Nederlands german Dieses ist deutsch output for all languages 21 152 amp This command writes the amp character to output This character has to be escaped because it has a special meaning in HTML 21 153 A This command writes the character to the output This character has to be escaped in some cases because it is used to expand environment variables Generated by Doxygen 21 154 155 21 154 Mk This command writes the character to the output This character has to be escaped in some cases because it is used to refer to documented entities 21 155 lt This command writes the lt character to the output This character has to be escaped because it has a special meaning in HTML 21 156 gt This command writes the gt character to the output This character has to be escaped because it has a special meaning in HTML 21 157 This command writes the character to the output This character has to be escaped in some cases because it is used to prevent a
117. ape to cancel the search The filter options can be selected when Generated by Doxygen 106 Configuration the cursor is inside the search box by pressing Shift cursor down Also here use the cursor keys to select a filter and enter or escape to activate or cancel the filter option SERVER_BASED_SEARCH When the SERVER_BASED_SEARCH tag is enabled the search engine will be im plemented using a PHP enabled web server instead of at the web client using Javascript Doxygen will generate the search PHP script and index file to put on the web server The advantage of the server based approach is that it scales better to large projects and also allows full text search The disadvantages are that it is more difficult to setup and does not have live searching capabilities DISABLE_INDEX If you want full control over the layout of the generated HTML pages it might be necessary to disable the index and replace it with your own The DISABLE_ INDEX tag can be used to turn on off the condensed index at top of each page A value of NO the default enables the index and the value YES disables it Since the tabs have the same information as the navigation tree you can set this option to NO if you already set GENERATE_TREEVIEW to YES ENUM_VALUES_PER_LINE This tag can be used to set the number of enum values range 0 1 20 that doxy gen will group on one line in the generated HTML documentation Note that a value of O will completely supp
118. as a real member of the class This can be useful when the programming language does not support the concept of member functions natively e g C Generated by Doxygen 124 Special Commands It is also possible to use this command together with public protected or private The file manual c in the example directory shows how to use this command See also sections extends implements public protected and private 21 24 1 name header This command turns a comment block into a header definition of a member group The comment block should be followed by a block containing the members of the group See section Member Groups for an example 21 25 namespace lt name gt Indicates that a comment block contains documentation for a namespace with name lt name gt 21 26 nosubgrouping This command can be put in the documentation of a class It can be used in combination with member grouping to avoid that doxygen puts a member group as a subgroup of a Public Protected Private section See also sections publicsection protectedsection and privatesection 21 27 overload function declaration This command can be used to generate the following standard text for an overloaded member function This is an overloaded member function provided for convenience It differs from the above function only in what argument s it accepts If the documentation for the overloaded member function is not
119. bin ld Unsatisfied symbols alloca code then you should according to Anke Selig edit ce_parse cpp and replace extern C void alloca unsigned int with include lt alloca h gt If that does not help try removing ce_parse cpp and let bison rebuild it this worked for me If you are compiling for Digital UNIX the same problem can be solved according to Barnard Schmallhof by replac ing the following in ce_parse cpp telse not GNU C x if defined __STDC__ amp amp defined sparc defined __sparc__ defined __sparc defined __sgi include lt alloca h gt with else x not GNU C if defined __STDC__ amp amp defined sparc defined __sparc__ defined __sparc defined __sgi defined __osf__ include lt alloca h gt Alternatively one could fix the problem at the bison side Here is patch for bison simple provided by Andre Johansen Generated by Doxygen 10 Installation bison simple Tue Nov 18 11 45 53 1997 bison simple Mon Jan 26 15 10 26 1998 27 7 27 7 ifdef __GNUC__ define alloca __builtin_alloca else not GNU C x if defined __STDC__ amp amp defined sparc defined __sparc__ defined __sparc defined __sgi if defined __STDC__ amp amp defined sparc defined __sparc__ defined __sparc defined __sgi defined __alpha include lt alloca h gt els
120. blic protected and private sections as well as the Qt specific signal and slots sec tions Extraction of private class members is optional Automatically generates references to documented classes files namespaces and members Documentation of global functions global variables typedefs defines and enumerations is also supported 86 Features References to base super classes and inherited overridden members are generated automatically Includes a fast rank based search engine to search for strings or words in the class and member documen tation PHP based Includes an Javascript based live search feature to search for symbols as you type for small to medium sized projects You can type normal HTML tags in your documentation Doxygen will convert them to their equivalent IATEX RTF and man page counterparts automatically Allows references to documentation generated for other doxygen documented projects or another part of the same project in a location independent way Allows inclusion of source code examples that are automatically cross referenced with the documentation Inclusion of undocumented classes is also supported allowing to quickly learn the structure and interfaces of a large piece of code without looking into the implementation details Allows automatic cross referencing of documented entities with their definition in the source code All source code fragments are syntax highlighted for ease of readi
121. brackets after the code block Here is an example code py class Python pass endcode code cpp class Cpp endcode See also section endcode and section verbatim 21 116 copydoc lt link object gt Copies a documentation block from the object specified by lt link object gt and pastes it at the location of the com mand This command can be useful to avoid cases where a documentation block would otherwise have to be duplicated or it can be used to extend the documentation of an inherited member The link object can point to a member of a class file or group a class a namespace a group a page or a file checked in that order Note that if the object pointed to is a member function variable typedef etc the compound class file or group containing it should also be documented for the copying to work To copy the documentation for a member of a class one can for instance put the following in the documentation x copydoc MyClass myfunction More documentation if the member is overloaded you should specify the argument types explicitly without spaces like in the following copydoc MyClass myfunction typel type2 Qualified names are only needed if the context in which the documentation block is found requires them The copydoc command can be used recursively but cycles in the copydoc relation will be broken and flagged as an error Note that copydoc foo is roughly equ
122. by Doxygen 20 8 HTML related options 105 HHC_LOCATION If the GENERATE_HTMLHELP tag is set to YES the HHC_LOCATION tag can be used to specify the location absolute path including file name of the HTML help compiler hhc exe If non empty doxygen will try to run the HTML help compiler on the generated index hhp GENERATE_CHI If the GENERATE_HTMLHELP tag is set to YES the GENERATE_CHI flag controls if a sepa rate chi index file is generated YES or that it should be included in the master chm file NO CHM_INDEX_ENCODING lf the GENERATE_HTMLHELP tag is set to YES the CHM_INDEX_ENCODING is used to encode HtmlHelp index hhk content hhc and project file content BINARY_TOC Ifthe GENERATE_HTMLHELP tag is set to YES the BINARY_TOC flag controls whether a binary table of contents is generated YES or a normal table of contents NO in the chm file TOC_EXPAND The TOC_EXPAND flag can be set to YES to add extra items for group members to the table of contents of the HTML help documentation and to the tree view GENERATE_QHP If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_ FOLDER are set an additional index file will be generated that can be used as input for Qt s qhelpgenerator to generate a Qt Compressed Help qch of the generated HTML documentation QCH_ FILE lf the QHG_LOCATION tag is sp
123. cide use some suitable translator adapter to finish the changes later and still make your translator working The most radical way of updating the language translator is to make your translator class derive directly from the abstract class Translator and provide translations for the methods that are required to be implemented the compiler will tell you if you forgot to implement some of them If you are in doubt have a look at the Translator English class to recognize the purpose of the implemented method Looking at the previously used adapter class may help you sometimes but it can also be misleading because the adapter classes do implement also the obsolete methods see the previous trFiles example In other words the up to date language translators do not need the TranslatorAdapter_x_y_z classes at all and you do not need to implement anything else than the methods required by the Translator class i e the pure virtual methods of the Translator they end with 0 If everything compiles fine try to run translator py and have a look at the translator report ASCII file at the doxygen doc directory Even if your translator is marked as up to date there still may be some remarks related to your source code Namely the obsolete methods that are not used at all may be listed in the section for your language Simply remove their code and run the translator py again Also you will be informed when you forgot to change the base c
124. ck if doxygen supports your programming language First assure that your programming language has a reasonable chance of being recognized by Doxygen These languages are supported by default C C C Objective C IDL Java VHDL PHP Python Tcl Fortran and D It is possible to configure certain file type extensions to use certain parsers see the Configuration Extension Mappings for details Also completely different languages can be supported by using preprocessor programs see the Helpers page for details 2 2 Step 1 Creating a configuration file Doxygen uses a configuration file to determine all of its settings Each project should get its own configuration file A project can consist of a single source file but can also be an entire source tree that is recursively scanned To simplify the creation of a configuration file doxygen can create a template configuration file for you To do this call doxygen from the command line with the g option doxygen g lt config file gt where lt config file gt is the name of the configuration file If you omit the file name a file named Doxyfile will be created If a file with the name lt config file gt already exists doxygen will rename it to lt config file gt bak before generating the configuration template If you use i e the minus sign as the file name then doxygen will try to read the configuration file from standard input st din which can be useful for scripting The
125. command starts a paragraph with a user defined heading The heading extends until the end of the line The paragraph following the command will be indented If no paragraph title is given this command will start a new paragraph This will also work inside other paragraph commands like param or warning without ending that command The text of the paragraph has no special internal structure All visual enhancement commands may be used inside the paragraph The par command ends when a blank line or some other sectioning command is encountered Example class Test Normal text Xpar User defined paragraph Contents of the paragraph par New paragraph under the same heading note This note consists of two paragraphs This is the first paragraph par And this is the second paragraph More normal text F F F F F F F F F HF OF class Test 21 68 param dir lt parameter name gt parameter description Starts a parameter description for a function parameter with name lt parameter name gt followed by a description of the parameter The existence of the parameter is checked and a warning is given if the documentation of this or any other parameter is missing or not present in the function declaration or definition The param command has an optional attribute dir specifying the direction of the parameter Possible values are in in out and out note the square bracket
126. configuration file has a format that is similar to that of a simple Makefile It consists of a number of assignments tags of the form TAGNAME VALUE or TAGNAME VALUE1 VALUE2 You can probably leave the values of most tags in a generated template configuration file to their default value See section Configuration for more details about the configuration file If you do not wish to edit the config file with a text editor you should have a look at doxywizard which is a GUI front end that can create read and write doxygen configuration files and allows setting configuration options by entering them via dialogs For a small project consisting of a few C and or C source and header files you can leave INPUT tag empty and doxygen will search for sources in the current directory If you have a larger project consisting of a source directory or tree you should assign the root directory or directories to the INPUT tag and add one or more file patterns to the FILE_PATTERNS tag for instance cpp h Only files that match one of the patterns will be parsed if the patterns are omitted a list of typical patterns is used for the types of files doxygen supports For recursive parsing of a source tree you must set the RECURSIVE tag to YES To further fine tune the list of files that is parsed the EXCLUDE and EXCLUDE_PATTERNS tags can be used To omit all test directories from a source tree for instance one could use
127. cript which automatically adds or removes d from the correct line in the Makefile usr bin perl Sfile shift ARGV print Toggle debugging mode for file n add or remove the d flex flag in the makefile unless rename Makefile libdoxygen Makefile libdoxygen old print STDERR Error cannot rename Makefile libdoxygen n exit 1 if open F lt Makefile libdoxygen old unless open G gt Makefile libdoxygen print STDERR Error opening file Makefile libdoxygen for writing n exit 1 print Processing Makefile libdoxygen n while lt F gt if 8 LEX del J PHP a Z2A Z2 4 YY t Sfiile LEX d VIEP 2yY tileja Y Y print Enabling debug info for file n elsif s LEX d i P a zA Z YY t Sfile LEX 1 P 2YY t file g print Disabling debug info for file n print G close F unlink Makefile libdoxygen old else print STDERR Warning file Makefile libdoxygen old does not exist n touch the file Snow time utime Snow Snow file Generated by Doxygen Chapter 25 Perl Module Output format Since version 1 2 18 Doxygen can generate a new output format we have called the Perl Module output format It has been designed as an intermediate format that can be used to generate new and customized output without having to modify the Doxygen source Therefore its purpose is similar to the XML output format that can be also generated by D
128. ct amount of s or s is not important 34 Markdown Alternatively you can use s at the start of a line to make a header The number of s at the start of the line determines the level up to 6 levels are supported You can end a header by any number of s Here is an example This is a level 1 header This is level 3 header H 4 1 3 Block quotes Block quotes can be created by starting each line with one or more gt s similar to what is used in text only emails gt This is a block quote gt spanning multiple lines Lists and code blocks see below can appear inside a quote block Quote blocks can also be nested Note that doxygen requires that you put a space after the last gt character to avoid false positives i e when writing 0 if OK n gt 1 if NOK the second line will not be seen as a block quote 4 1 4 Lists Simple bullet lists can be made by starting a line with or x Item 1 More text for this item Item 2 nested list item another nested item Item 3 List items can span multiple paragraphs if each paragraph starts with the proper indentation and lists can be nested You can also make a numbered list like so 1 First item 2 Second item 4 1 5 Code Blocks Preformatted verbatim blocks can be created by indenting each line in a block of text by at least 4 extra spaces This a normal paragraph This is a code block We continue with a normal paragrap
129. d ingroup commands but for pages the subpage command is often more convenient The main page see mainpage is typically the root of hierarchy This command behaves similar as ref in the sense that it creates a reference to a page labeled lt name gt with the optional link text as specified in the second argument It differs from the ref command in that it only works for pages and creates a parent child relation between pages where the child page or sub page is identified by label lt name gt See the section and subsection commands if you want to add structure without creating multiple pages Generated by Doxygen 140 Special Commands Note Each page can be the sub page of only one other page and no cyclic relations are allowed i e the page hierarchy must have a tree structure Here is an example x mainpage A simple manual Some general info This manual is divided in the following sections subpage intro subpage advanced Advanced usage x page intro Introduction This page introduces the user to the topic Now you can proceed to the ref advanced advanced section page advanced Advanced Usage This page is for advanced users Make sure you have first read ref intro the introduction 21 96 tableofcontents Creates a table of contents at the top of a page listing all sections and subsections in the page Warning This command only works inside related page doc
130. de for an example 21 106 skipline pattern This command searches line by line through the example that was last included using include or dontinclude until it finds a line that contains the specified pattern It then writes the line to the output The internal pointer that is used to keep track of the current line in the example is set to the start of the line following the line that is written or to the end of the example if the pattern could not be found Note The command skipline pattern is equivalent to skip pattern line pattern See section dontinclude for an example 21 107 snippet lt file name gt block id Where the include command can be used to include a complete file as source code this command can be used to quote only a fragment of a source file For example the putting the following command in the documentation references a snippet in file example cpp residing in a subdirectory which should be pointed to by EXAMPLE_PATH snippet snippets example cpp Adding a resource The text following the file name is the unique identifier for the snippet This is used to delimit the quoted code in the relevant snippet file as shown in the following example that corresponds to the above snippet command Generated by Doxygen 144 Special Commands QImage image 64 64 QImage Format_RGB32 image fill qRgb 255 160 128 Adding a resource document gt addResource OTextDocument
131. declspec a NM BEGIN_CONNECTION_POINT_MAP x END_CONNECTION_POINT_MAP x DECLARE_DYNAMIC class IMPLEMENT_DYNAMIC classl class2 DECLARE_DYNCREATE class IMPLEMENT_DYNCREATE class1 class2 IMPLEMENT_SERIAL class1 class2 class3 DECLARE_MESSAGE_MAP A TRY try CATCH_ALL e catch END_CATCH_ALL THROW_LAST throw RUNTIME _CLASS class class MAKEINTRESOURCE nId nId IMPLEMENT_REGISTER v w X Y z ASSERT x assert x ASSERT_VALID x assert x TRACEO x printf x A OS_ERR A B 1 HA B __cplusplus DECLARE_OLECREATE class BEGIN_DISPATCH_MAP classl class2 BEGIN_INTERFACE_MAP classl class2 INTERFACE _PART class id name END_INTERFACE_MAP DISP_FUNCTION class name function result END_DISPATCH_MAP IMPLEMENT_OLECREATE2 class name idl id2 id5 id6 id7 id8 id9 idl0 id11 id id3 id4 As you can see doxygen s preprocessor is quite powerful but if you want even more flexibility you can always write an input filter and specify it after the INPUT_FILTER tag If you are unsure what the effect of doxygen s preprocessing will be you can run doxygen as follows Generated by Doxygen 58 Preprocessing doxygen d Preprocessor This will instruct doxygen to dump the input sources to standard output af
132. ding Formulas Doxygen allows you to put IATEX formulas in the output this works only for the HTML and IATEX output not for the RTF nor for the man page output To be able to include formulas as images in the HTML documentation you will also need to have the following tools installed e latex the IATEX compiler needed to parse the formulas To test have used the teTeX 1 0 distribution e dvips a tool to convert DVI files to PostScript files have used version 5 92b from Radical Eye software for testing e gs the GhostScript interpreter for converting PostScript files to bitmaps have used Aladdin GhostScript 8 0 for testing For the HTML output there is also an alternative solution using Mat hJax which does not require the above tools If you enable USE_MATHJAX in the config then the latex formulas will be copied to the HTML as is and a client side javascript will parse them and turn them into interactive images There are three ways to include formulas in the documentation 1 Using in text formulas that appear in the running text These formulas should be put between a pair of f commands so The distance between f x_l1 y_1 f and f x_2 y_2 fS is f sqrt x_2 x_1 2 y_2 y_1 2 f results in The distance between x1 y1 and x2 y2 is J x2 x1 2 y1 2 Unnumbered displayed formulas that are centered on a separate line These formulas should be put between fL and f commands
133. e environment variables like HOME are resolved inside a HTML only block See also section manonly section latexonly and section rtfonly 21 140 image lt format gt lt file gt caption lt sizeindication gt lt size gt Inserts an image into the documentation This command is format specific so if you want to insert an image for more than one format you ll have to repeat this command for each format The first argument specifies the output format Currently the following values are supported html latex and ECE The second argument specifies the file name of the image doxygen will look for files in the paths or files that you specified after the IMAGE_PATH tag If the image is found it will be copied to the correct output directory If the image name contains spaces you ll have to put quotes around it You can also specify an absolute URL instead of a file name but then doxygen does not copy the image nor check its existence The third argument is optional and can be used to specify the caption that is displayed below the image This argument has to be specified on a single line and between quotes even if it does not contain any spaces The quotes are stripped before the caption is displayed Generated by Doxygen 152 Special Commands The fourth argument is also optional and can be used to specify the width or height of the image This is only useful for lAT X output i e format 1atex The
134. e not sparc if defined MSDOS amp amp defined __TURBOC__ The generated scanner cpp that comes with doxygen is build with this patch applied Sun compiler problems It appears that doxygen doesn t work properly if it is compiled with Sun s C WorkShop 6 Compiler cannot verify this myself as do not have access to a Solaris machine with this compiler With GNU compiler it does work and installing Sun patch 111679 13 has also been reported as a way to fix the problem when configuring with st atic got Undefined first referenced symbol in file dlclose usr lib libc a nss_deffinder o dlsym usr lib libc a nss_deffinder o dlopen usr lib libc a nss_deffinder o Manually adding Bdynamic after the target rule in Makefile doxygen will fix this TARGET S OBJECTS OBJMOC S LINK S LFLAGS o S TARGET OBJECTS OBJMOC LIBS Bdynamic GCC compiler problems Older versions of the GNU compiler have problems with constant strings containing characters with character codes larger than 127 Therefore the compiler will fail to compile some of the translator_xx h files A workaround if you are planning to use the English translation only is to configure doxygen with the english on1y option On some platforms such as OpenBSD using some versions of gcc with O2 can lead to eating all memory during the compilation of files such as config cpp As a workaround use debug as a configure option or omit the O2
135. e enum to document an enumeration type e Y n to document a function e Ivar to document a variable or typedef or enum value e def to document a define e typedef to document a type definition e file to document a file namespace to document a namespace e package to document a Java package e interface to document an IDL interface See section Special Commands for detailed information about these and many other commands To document a member of a C class you must also document the class itself The same holds for namespaces To document a global C function typedef enum or preprocessor definition you must first document the file that contains it usually this will be a header file because that file contains the information that is exported to other source files Let s repeat that because it is often overlooked to document global objects functions typedefs enum macros etc you must document the file in which they are defined In other words there must at least be a x file x ora x x file x line in this file Here is an example of a C header named st ruct cmd h that is documented using structural commands file structcmd h brief A Documented file Details x def MAX a b brief A macro that returns the maximum of Na a and la b Details Generated by Doxygen 26 Documenting the code x Nvar typedef unsigned int UINT32 brief A type definition for a
136. e which is required to separate the brief description from the block containing the detailed description The JAVADOC_AUTOBRIEF should also be set to NO for this case As you can see doxygen is quite flexible If you have multiple detailed descriptions like in the following example Brief description which is really a detailed description since it spans multiple lines Another detailed description They will be joined Note that this is also the case if the descriptions are at different places in the code In this case the order will depend on the order in which doxygen parses the code Unlike most other documentation systems doxygen also allows you to put the documentation of members including global functions in front of the definition This way the documentation can be placed in the source file instead of the header file This keeps the header file compact and allows the implementer of the members more direct access to the documentation As a compromise the brief description could be placed before the declaration and the detailed description before the member definition 3 1 1 1 Putting documentation after members If you want to document the members of a file struct union class or enum it is sometimes desired to place the documentation block after the member instead of before For this purpose you have to put an additional lt marker in the comment block Note that this also works for the parameters of a function
137. e QUIET tag can be used to turn on off the messages that are generated to standard output by doxygen Possible values are YES and NO where YES implies that the messages are off If left blank NO is used WARNINGS The WARNINGS tag can be used to turn on off the warning messages that are generated to standard error by doxygen Possible values are YES and NO where YES implies that the warnings are on If left blank NO is used Tip Turn warnings on while writing the documentation WARN_IF_UNDOCUMENTED lf WARN_IF_UNDOCUMENTED is set to YES then doxygen will generate warnings for undocumented members If EXTRACT_ALL is set to YES then this flag will automatically be disabled WARN_IF_DOC_ERROR If WARN_IF_DOC_ERROR is set to YES doxygen will generate warnings for poten tial errors in the documentation such as not documenting some parameters in a documented function or documenting parameters that don t exist or using markup commands wrongly WARN_NO_PARAMDOC This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that are documented but have no documentation for their parameters or return value If set to NO the default doxygen will only warn about wrong or incomplete parameter documentation but not about the absence of documentation WARN_FORMAT The WARN_FORMAT tag determines the format of the warning messages that doxygen can pro duce The string should contain the file line and
138. e documentation See section Doxygen usage for more detailed usage information Optionally the executable doxywizard can be used which is a graphical front end for editing the configuration file that is used by doxygen and for running doxygen in a graphical environment For Mac OS X doxywizard will be started by clicking on the Doxygen application icon The following figure shows the relation between the tools and the flow of information between them it looks complex but that s only because it tries to be complete gt A EN Doxywizard Your application custom d output rea generate edit XML files del doxmlparser lib Config file j Layout file Doxyfile AAA make ps postscript E L fil generate generate alex tiles latex read update Bg T ial E Makefile make pdf PDF read Lr Sources j Doxygen P pp read read generate Man pages Custom ve headers LH osa Tag file s A A ee es images J l Windows only _ import doc refman rtf T MS Word m i HTML read chm pages gt HTML Help Workshop gt Figure 2 1 Doxygen information flow 14 Getting Started 2 1 Step 0 Che
139. e features defined by Markdown Extra is support for simple tables A table consists of a header line a separator line and at least one row line Table columns are separated by the pipe character Here is an example First Header Second Header EEE EN E ee as is ache ea Rect pat Bat ED VPF PI Content Cell Content Cell Content Cell Content Cell which will produce the following table First Header Second Header Content Cell Content Cell Content Cell Content Cell Column alignment can be controlled via one or two colons at the header separator line Right Center Left se 10 10 10 1000 1000 1000 which will look as follows Right Center Left 10 10 10 1000 1000 1000 4 2 3 Fenced Code Blocks Another feature defined by Markdown Extra is support for fenced code blocks A fenced code block does not require indentation and is defined by a pair of fence lines Such a line consists of 3 or more tilde characters on a line The end of the block should have the same number of tildes Here is an example This is a paragraph introducing Generated by Doxygen 38 Markdown By default the output is the same as for a normal code block For languages supported by doxygen you can also make the code block appear with syntax highlighting To do so you need to indicate the typical file extension that corresponds to the programming
140. e files or directories that contain example code fragments that are included see the l include command in section include EXAMPLE RECURSIVE If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be searched for input files to be used with the include or dontinclude commands irrespective of the value of the RECU RSIVE tag Possible values are YES and NO If left blank NO is used EXAMPLE PATTERNS If the value of the EXAMPLE_PATH tag contains directories you can use the EXAMPL E PATTERNS tag to specify one or more wildcard pattern like cpp and h to filter out the source files in the directories If left blank all files are included IMAGE_PATH The IMAGE_PATH tag can be used to specify one or more files or directories that contain images that are to be included in the documentation see the image command INPUT_FILTER The INPUT_FILTER tag can be used to specify a program that doxygen should invoke to filter for each input file Doxygen will invoke the filter program by executing via popen the command lt filter gt lt input file gt where lt filter gt is the value of the INPUT_FILTER tag and lt input file gt is the name of an input file Doxy gen will then use the output that the filter program writes to standard output Generated by Doxygen 20 6 Source browsing related options 101 FILTER_PATTERNS The FILTER_PATTERNS
141. e hidden If the box has a dashed border this indicates virtual inheritance A solid arrow indicates public inheritance A dashed arrow indicates protected inheritance A dotted arrow indicates private inheritance The elements in the graphs generated by the dot tool have the following meaning A white box indicates a class or struct or file A box with a red border indicates a node that has more arrows than are shown In other words the graph is truncated with respect to this node The reason why a graph is sometimes truncated is to prevent images from becoming too large For the graphs generated with dot doxygen tries to limit the width of the resulting image to 1024 pixels A black box indicates that the class documentation is currently shown A dark blue arrow indicates an include relation for the include dependency graph or public inheritance for the other graphs A dark green arrow indicates protected inheritance A dark red arrow indicates private inheritance A purple dashed arrow indicated a usage relation the edge of the arrow is labeled with the variable s responsible for the relation Class A uses class B if class A has a member variable m of type C where B is a subtype of C e g C could be B Bx T lt B gt Here are a couple of header files that together show the various diagrams that doxygen can generate diagrams_a h ifndef _DIAGRAMS_A_H define _DIAGRAMS_A_H class A public A m_self
142. e images gen erated by dot Possible values are svg png jpg or gif If left blank png will be used Note If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files visible in IE 9 other browsers do not have this requirement INTERACTIVE_SVG If DOT_IMAGE_FORMAT is set to svg then this option can be set to YES to enable gen eration of interactive SVG images that allow zooming and panning Note that this requires a modern browser other than Internet Explorer Tested and working are Firefox Chrome Safari and Opera Note For IE 9 you need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files visible Older versions of IE do not have SVG support DOT_PATH This tag can be used to specify the path where the dot tool can be found If left blank it is assumed the dot tool can be found on the path DOTFILE_DIRS This tag can be used to specify one or more directories that contain dot files that are included in the documentation see the dotfile command MSCFILE_DIRS This tag can be used to specify one or more directories that contain msc files that are included in the documentation see the mscfile command DOT_TRANSPARENT Set the DOT_TRANSPARENT tag to YES to generate images with a transparent back ground This is disabled by default because dot on Windows does not seem to support this out of the box Warning Depending on the platform used enabling this option may
143. e then you can use the optional s option This can use be used in combination with the u option to add or strip the documentation from an existing configuration file Please use the s option if you send me a configuration file as part of a bug report To make doxygen read write to standard input output instead of from to a file use for the file name Generated by Doxygen Chapter 19 Doxywizard usage Doxywizard is a GUI front end for configuring and running doxygen When you start doxywizard it will display the main window the actual look depends on the OS used The windows shows the steps to take to configure and run doxygen The first step is to choose one of the ways to configure doxygen Wizard Click this button to quickly configure the most important settings and leave the rest of the options to their defaults Expert Click this button to gain access to the full range of configuration options Load Click this button to load an existing configuration file from disk Note that you can select multiple buttons in a row for instance to first configure doxygen using the Wizard and then fine tune the settings via the Expert After doxygen is configured you need to save the configuration as a file to disk This second step allows doxygen to use the configuration and has the additional advantage that the configuration can be reused to run doxygen with the same settings at a later point in time Since some configuration
144. ecified the QCH_FILE tag can be used to specify the file name of the resulting qch file The path specified is relative to the HTML output folder QHP_ NAMESPACE The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help Project output For more information please see Ot Help Project Namespace QHP_VIRTUAL_FOLDER The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt Help Project output For more information please see Ot Help Project Virtual Folders QHP_CUST_FILTER_NAME If QHP_CUST_FILTER_NAME is set it specifies the name of a custom filter to add For more information please see Ot Help Project Custom Filters QHP_CUST_FILTER_ATTRS The QHP_CUST_FILTER_ATTRIBUTES tag specifies the list of the attributes of the custom filter to add For more information please see Ot Help Project Custom Filters QHP_SECT FILTER_ATTRS The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project s filter section matches Qt Help Project Filter Attributes QHG LOCATION Ifthe GENERATE_QHP tag is set to YES the QHG_LOCATION tag can be used to specify the location of Qt s qhelpgenerator If non empty doxygen will try to run qhelpgenerator on the generated qhp file GENERATE _ECLIPSEHELP If the GENERATE_ECLIPSEHELP tag is set to YES additional index files will be generated which together with the HTML files form an Eclipse help plugin To install this plugin and
145. ed void func2InGroup2 y void Test funclInGroupl void Test func2InGroupl name Group2 Description of group 2 1 1 04 x Function 2 in group 2 Details void Test func2InGroup2 x Function 1 in group 2 Details x void Test funclInGroup2 file docs for this file one description for all members of this group because DISTRIBUTE_GROUP_DOC is YES in the config file define A 1 define B 2 void glob_func Generated by Doxygen 5 3 Subpaging 47 Here Group1 is displayed as a subsection of the Public Members And Group2 is a separate section because it contains members with different protection levels i e public and protected 5 3 Subpaging Information can be grouped into pages using the page and mainpage commands Normally this results in a flat list of pages where the main page is the first in the list Instead of adding structure using the approach described in section modules it is often more natural and convenient to add additional structure to the pages using the subpage command For a page A the subpage command adds a link to another page B and at the same time makes page B a subpage of A This has the effect of making two groups GA and GB where GB is part of GA page A is put in group GA and page B is put in group GB Generated by Doxygen 48 Grouping Generated by Doxygen Chapter 6 Inclu
146. ed member that it re implements SEPARATE MEMBER _ PAGES Ifthe SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new page for each member If set to NO the documentation of a member will be part of the file class names pace that contains it TAB SIZE the TAB_SIZE tag can be used to set the number of spaces in a tab Doxygen uses this value to replace tabs by spaces in code fragments ALIASES This tag can be used to specify a number of aliases that acts as commands in the documentation An alias has the form name value For example adding sideeffect par Side Effects n will allow you to put the command sideeffect or sideeffect in the documentation which will result in a user defined paragraph with heading Side Effects You can put n s in the value part of an alias to insert newlines OPTIMIZE _OUTPUT_FOR_C Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources only Doxygen will then generate output that is more tailored for C For instance some of the names that are used will be different The list of all members will be omitted etc OPTIMIZE _OUTPUT_JAVA Set the OPTIMIZE _OUTPUT_JAVA tag to YES if your project consists of Java or Python sources only Doxygen will then generate output that is more tailored for that language For instance namespaces will be presented as packages qualified scopes will look different etc OPTIMIZE _FOR_
147. ed to include only a fragment of a source file For this to work the fragment has to be marked Note Doxygen s special commands do not work inside blocks of code It is allowed to nest C style comments inside a code block though See also sections example dontinclude and verbatim 21 103 includelineno lt file name gt This command works the same way as include but will add line numbers to the included file Generated by Doxygen 21 104 line pattern 143 See also section include 21 104 line pattern This command searches line by line through the example that was last included using include or dontinclude until it finds a non blank line If that line contains the specified pattern it is written to the output The internal pointer that is used to keep track of the current line in the example is set to the start of the line following the non blank line that was found or to the end of the example if no such line could be founa See section dontinclude for an example 21 105 skip pattern This command searches line by line through the example that was last included using include or dontinclude until it finds a line that contains the specified pattern The internal pointer that is used to keep track of the current line in the example is set to the start of the line that contains the specified pattern or to the end of the example if the pattern could not be found See section dontinclu
148. ed with a verbatim command See also section verbatim 21 133 endxmlonly Ends a block of text that was started with a xmlonly command See also section xmlonly 21 134 f Marks the start and end of an in text formula See also section formulas for an example 21 135 M Marks the start of a long formula that is displayed centered on a separate line See also section f and section formulas 21 136 f Marks the end of a long formula that is displayed centered on a separate line See also section f and section formulas Generated by Doxygen 21 137 f environment 151 21 137 f environment Marks the start of a formula that is in a specific environment Note The second is optional and is only to help editors such as Vim to do proper syntax highlighting by making the number of opening and closing braces the same See also section f and section formulas 21 138 f Marks the end of a formula that is in a specific environment See also section f and section formulas 21 139 htmlonly Starts a block of text that will be verbatim included in the generated HTML documentation only The block ends with a endhtmlonly command This command can be used to include HTML code that is too complex for doxygen i e applets java scripts and HTML tags that require attributes You can use the latexonly and endlatexonly pair to provide a proper ATEX alternative Not
149. egated to all generators in the list To allow small deviations in what is written to the output for each concrete output generator it is possible to tem porarily disable certain generators The OutputList class contains various disable and enable methods for this The methods OutputList pushGeneratorState and OutputList popGenerator State are used to temporarily save the set of enabled disabled output generators on a stack The XML is generated directly from the gathered data structures In the future XML will be used as an intermediate language IL The output generators will then use this IL as a starting point to generate the specific output formats The advantage of having an IL is that various independently developed tools written in various languages could extract information from the XML output Possible tools could be an interactive source browser e a class diagram generator computing code metrics Generated by Doxygen 168 Doxygen s internals Debugging Since doxygen uses a lot of flex code it is important to understand how flex works for this one should read the man page and to understand what it is doing when flex is parsing some input Fortunately when flex is used with the d option it outputs what rules matched This makes it quite easy to follow what is going on for a particular input fragment To make it easier to toggle debug information for a given flex file wrote the following perl s
150. einitializer By default the value of a define and the initializer of a variable are displayed unless they are longer than 30 lines By putting this command in a comment block of a define or variable the initializer is always hidden The maximum number of initialization lines can be changed by means of the configuration parameter MAX_INITIALIZER_LINES the default value is 30 See also section showinitializer 21 18 implements lt name gt This command can be used to manually indicate an inheritance relation when the programming language does not support this concept natively e g C The file manual c in the example directory shows how to use this command See also section extends and section memberof 21 19 ingroup lt groupname gt lt groupname gt lt groupname gt If the ingroup command is placed in a comment block of a class file or namespace then it will be added to the group or groups identified by lt groupname gt See also page Grouping sections defgroup addtogroup and weakgroup Generated by Doxygen 21 20 interface lt name gt lt header file gt lt header name gt 123 21 20 interface lt name gt lt header file gt lt header name gt Indicates that a comment block contains documentation for an interface with name lt name gt The arguments are equal to the arguments of the class command See also section class 21 21 internal This command starts a docu
151. elong to the same semantic group Generated by Doxygen 46 Grouping A member group is defined by a 11 04 1118 block or a JQ lx Jase block if you prefer C style comments Note that the members of the group should be physically inside the member group s body Before the opening marker of a block a separate comment block may be placed This block should contain the name or name command and is used to specify the header of the group Optionally the comment block may also contain more detailed information about the group Nesting of member groups is not allowed If all members of a member group inside a class have the same type and protection level for instance all are static public members then the whole member group is displayed as a subgroup of the type protection level group the group is displayed as a subsection of the Static Public Members section for instance If two or more members have different types then the group is put at the same level as the automatically generated groups If you want to force all member groups of a class to be at the top level you should put a nosubgrouping command inside the documentation of the class Example A class Details class Test public Same documentation for both members Details x void funcliInGroupl void func2InGroupl x Function without group Details x void ungroupedFunction void funclInGroup2 protect
152. et lejordet at gmail dot com 1 4 6 Persian Ali Nadalizadeh nadalizadeh at gmail dot com 1 7 5 Polish Piotr Kaminski unreachable Piotr dot Kaminski at ctm dot gdynia dot pl 1 6 3 Grzegorz Kowal unreachable g_kowal at poczta dot onet dot pl Krzysztof Kral krzysztof dot kral at gmail dot com Portuguese Rui Godinho Lopes resigned rgl at ruilopes dot com up to date searching for the maintainer Please try to help to find someone Romanian lonut Dumitrascu reddumy at yahoo dot com 1 6 0 Alexandru losup aiosup at yahoo dot com Russian Alexandr Chelpanov cav at cryptopro dot ru 1 7 5 Serbian Dejan Milosavljevic unreachable dmilos at email dot com 1 6 0 SerbianCyrilic Nedeljko Stefanovic stenedjo at yahoo dot com 1 6 0 Slovak Kali Laco Svec the Slovak language advisors up to date Petr Prikryl prikrylp at skil dot cz Slovene Matja Ostrover nik matjaz dot ostroversnik at ostri dot org 1 4 6 Spanish Bartomeu bartomeu at loteria3cornella dot com 1 7 5 Francisco Oltra Thennet unreachable foltra at puc dot cl David Vaquero david at grupoikusnet dot com Swedish Mikael Hallin mikaelhallin at yahoo dot se 1 6 0 Turkish Emin Ilker Cetinbas niw3 at yahoo dot com 1 7 5 Ukrainian Olexij Tkatchenko resigned olexij at tkatchenko dot com 1 4 1 searching for the maintainer Please try to help to find someone Vietnamese Dang Minh Tuan tuanvietkey at gmail dot com 1 6 0 Most people on the list have indicated that they were a
153. ex chm for project b into b chm In the configuration file for project a you write TAGFILES b tag b chm or you can use installdox to set the links as follows installdox lb tag b chm don t like the quick index that is put above each HTML page what do I do You can disable the index by setting DISABLE_INDEX to YES Then you can put in your own header file by writing your own header and feed that to HTML_HEADER The overall HTML output looks different while only wanted to use my own html header file You probably forgot to include the stylesheet doxygen css that doxygen generates You can include this by putting lt LINK HREF doxygen css REL stylesheet TYPE text css gt Generated by Doxygen 79 10 11 12 13 14 15 16 17 in the HEAD section of the HTML page Why does doxygen use Qt The most important reason is to have a platform abstraction for most Unices and Windows by means of the QFile GFilelnfo QDir QDate QTime and QlODevice classes Another reason is for the nice and bug free utility classes like QList QDict QString QArray QTextStream QRegExp QXML etc The GUI front end doxywizard uses Qt for well the GUI How can exclude all test directories from my directory tree Simply put an exclude pattern like this in the configuration file EXCLUDE_PATTERNS test Doxygen automatically generates a link to the class MyClass somewhere in the
154. external sources Doxygen can both generate and read tag files To generate a tag file for your project simply put the name of the tag file after the GENERATE_TAGFILE option in the configuration file To combine the output of one or more external projects with your own project you should specify the name of the tag files after the TAGFILES option in the configuration file A tag file typically only contains a relative location of the documentation from the point where doxygen was run So when you include a tag file in other project you have to specify where the external documentation is located in relation this project You can do this in the configuration file by assigning the relative location to the tag files specified after the TAGFILES configuration option If you use a relative path it should be relative with respect to the directory where the HTML output of your project is generated so a relative path from the HTML output directory of a project to the HTML output of the other project that is linked to Example Suppose you have a project proj that uses two external projects called ext1 and ext2 The directory structure looks as follows 76 Link to external documentation lt root gt proj html src proj cpp ext1 html extl tag ext2 html ext2 tag proje cfg extl cfg ext2 cfg HTML output directory sources for proj HTML output directory tag file for ext1 HTML output direct
155. f supported by the output format e lt A NAME gt Starts an named anchor if supported by the output format e lt A gt Ends a link or anchor lt B gt Starts a piece of text displayed in a bold font e lt B gt Ends a lt B gt section lt BLOCKQUOTE gt Starts a quotation block e lt BLOCKQUOTE gt Ends the quotation block lt BODY gt Does not generate any output lt BODY gt Does not generate any output lt BR gt Forces a line break CJ e lt CENTER gt starts a section of centered text e lt CENTER gt ends a section of centered text lt CAPTION gt Starts a caption Use within a table only e lt CAPTION gt Ends a caption Use within a table only lt CODE gt Starts a piece of text displayed in a typewriter font Note that for C code this command is equivalent to code lt CODE gt Ends a lt CODE gt section Note that for C code this command is equivalent to endcode lt DD gt Starts an item description lt DFN gt Starts a piece of text displayed in a typewriter font e lt DFN gt Ends a lt DFN gt section lt DIV gt Starts a section with a specific style HTML only e lt DIV gt Ends a section with a specific style HTML only e lt DL gt Starts a description list e lt DL gt Ends a description list 158 HTML commands lt DT gt Starts an item title lt DT gt Ends an item title lt
156. f you want to do minor tweaking to the look and feel of the output The section Layout show how to reorder and hide certain information on a page The section XML output show how to generate whatever output you want based on the XML output produced by doxygen 12 1 Minor Tweaks The next subsections describe some aspects that can be tweaked with little effort 12 1 1 Overall Color To change the overall color of the HTML output doxygen provides three options e HTML_COLORSTYLE_HUE e HTML_COLORSTYLE_SAT e HTML_COLORSTYLE_GAMMA to change the hue saturation and gamma correction of the colors respectively For your convenience the GUI frontend Doxywizard has a control that allows you to see the effect of changing the values of these options on the output in real time 12 1 2 Navigation By default doxygen shows navigation tabs on top of every HTML page corresponding with the following settings e DISABLE_INDEX NO GENERATE_TREEVIEW NO you can switch to an interactive navigation tree as sidebar using e DISABLE_INDEX YES e GENERATE_TREEVIEW YES or even have both forms of navigation 68 Customizing the Output e DISABLE_INDEX NO e GENERATE_TREEVIEW YE E n if you already use an external index i e have one of the following options enabled GENERATE_HTMLHELP GE NERATE_ECLIPSEHELP GENERATE_QHP or GENERATE_DOCSET then you can also disable all indices like so e DISABLE_INDEX YES e
157. fendif diagrams_b h ifndef _DIAGRAMS_B_H define _DIAGRAMS_B_H class A class B public A m_a fendif diagrams_c h ifndef _DIAGRAMS_C_H define _DIAGRAMS_C_H include diagrams_c h class D class C public A public D m_d endif Generated by Doxygen 53 diagrams_d h ifndef _DIAGRAM_D_H define _DIAGRAM_D_H include diagrams_a h include diagrams_b h class C class D virtual protected A private B public tfendif diagrams_e h ifndef _DIAGRAM_E_H define _DIAGRAM_E_H include diagrams_d h class E public D fendif C m_c y Generated by Doxygen 54 Graphs and diagrams Generated by Doxygen Chapter 8 Preprocessing Source files that are used as input to doxygen can be parsed by doxygen s built in C preprocessor By default doxygen does only partial preprocessing That is it evaluates conditional compilation statements like if and evaluates macro definitions but it does not perform macro expansion So if you have the following code fragment define VERSION 200 define CONST_STRING const char if VERSION gt 200 static CONST_STRING version 2 xx else static CONST_STRING version 1 xx fendif Then by default doxygen will feed the following to its parser define VERSION define CONST_STRING static CONST_STRING version 2 xx You can disable all preprocessing by setting ENABLE _PREPROCESSING to NO in
158. ferent depending on whether or not ENABLED_SECTIONS contains TEST or DEV See also section endcond 21 54 copyright copyright description Starts a paragraph where the copyright of an entity can be described This paragraph will be indented The text of the paragraph has no special internal structure See section author for an example 21 55 date date description Starts a paragraph where one or more dates may be entered The paragraph will be indented The text of the paragraph has no special internal structure All visual enhancement commands may be used inside the paragraph Multiple adjacent date commands will be joined into a single paragraph Each date description will start on a new line Alternatively one date command may mention several dates The date command ends when a blank line or some other sectioning command is encountered See section author for an example 21 56 deprecated description Starts a paragraph indicating that this documentation block belongs to a deprecated entity Can be used to describe alternatives expected life span etc Generated by Doxygen 132 Special Commands 21 57 details detailed description Just like brief starts a brief description details starts the detailed description You can also start a new paragraph blank line then the details command is not needed 21 58 else Starts a conditional section if the previous conditional section was
159. files in the paths or files that you specified after the DOTFILE_DIRS tag If the dot file is found it will be used as an input file to the dot tool The resulting image will be put into the correct output directory If the dot file name contains spaces you ll have to put quotes around it The second argument is optional and can be used to specify the caption that is displayed below the image This argument has to be specified between quotes even if it does not contain any spaces The quotes are stripped before the caption is displayed 21 122 mscfile lt file gt caption Inserts an image generated by mscgen from lt file gt into the documentation See http www mcternan me uk mscgen for examples The first argument specifies the file name of the image doxygen will look for files in the paths or files that you specified after the MSCFILE_DIRS tag If the msc file is found it will be used as an input file to the mscgen tool The resulting image will be put into the correct output directory If the msc file name contains spaces you ll have to put quotes around it The second argument is optional and can be used to specify the caption that is displayed below the image This argument has to be specified between quotes even if it does not contain any spaces The quotes are stripped before the caption is displayed See also section msc 21 123 le lt word gt Displays the argument lt word gt in italics
160. fo how doxygen handles code spans slightly different than standard Markdown 4 1 9 Links Doxygen supports both styles of make links defined by Markdown inline and reference For both styles the link definition starts with the link text delimited by square brackets 4 1 9 1 Inline Links For an inline link the link text is followed by a URL and an optional link title which together are enclosed in a set of regular parenthesis The link title itself is surrounded by quotes Examples The link text The link text The link text The link text http example net http example net Link title relative path to index html Link title somefile html Generated by Doxygen 36 Markdown In addition doxygen provides a similar way to link a documented entity The link text ref MyClass 4 1 9 2 Reference Links Instead of putting the URL inline you can also define the link separately and then refer to it from within the text The link definition looks as follows link name http www example com Optional title Instead of double quotes also single quotes or parenthesis can be used for the title part Once defined the link looks as follows link text link name If the link text and name are the same also link name or even link name can be used to refer to the link Note that the link name matching is not case sensitive as is shown in the following example I get 10
161. following underlying design goal The design goal for Markdown s formatting syntax is to make it as readable as possible The idea is that a Markdown formatted document should be publishable as is as plain text without looking like its been marked up with tags or formatting instructions While Markdown s syntax has been influenced by several existing text to HTML filters the single biggest source of inspiration for Markdown s syntax is the format of plain text email In the next section the standard Markdown features are briefly discussed The reader is referred to the Markdown site for more details Some enhancements were made for instance PHP Markdown Extra and GitHub flavored Markdown The section Markdown Extensions discusses the extensions that doxygen supports Finally section Doxygen specifics discusses some specifics for doxygen s implementation of the Markdown standard 4 1 Standard Markdown 4 1 1 Paragraphs Even before doxygen had Markdown support it supported the same way of paragraph handling as Markdown to make a paragraph you just separate consecutive lines of text by one or more blank lines An example Here is text for one paragraph We continue with more text in another paragraph 4 1 2 Headers Just like Markdown doxygen supports two types of headers Level 1 or 2 headers can be made as the follows This is an level 1 header A header is followed by a line containing only s or s Note that the exa
162. ft double quotation mark amp xrdquo right double quotation mark amp ndash n dash for numeric ranges e g 2 8 amp mdash m dash for parenthetical punctuation like this amp uml1 where is one of A E 1 0 U Y a e i 0 u y writes a character with a diaeresis accent like a amp acute where is one of A E 1 O U Y a i 0 u y writes a character with a acute accent like Generated by Doxygen 160 HTML commands e amp grave where is one of A E O U a e i o u y writes a character with a grave accent like a e amp circ where is one of A E O U a e i o u y writes a character with a circumflex accent like a e amp tilde where is one of A N O a n o writes a character with a tilde accent like a szlig write a sharp s i e 3 to the output e amp cedil where is one of c C writes a c cedille like e amp ring where is one of a A writes an a with a ring like a nbsp anon breakable space Finally to put invisible comments inside comment blocks HTML style comments can be used lt This is a comment with a comment block gt Visible text x Generated by Doxygen Chapter 23 XML commands Doxygen supports most of the XML commands that are typically used in C code comments The XML tags are defined in Appendix E of the ECMA 334 standard which defines the C language Unfortunately the specification is not very preci
163. gly recommended to install a local copy of MathJax from http www mathjax org before deployment MATHJAX EXTENSIONS The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension names that should be enabled during MathJax rendering For example MATHJAX_EXTENSIONS TeX AMSmath TeX AMSsymbols Generated by Doxygen 20 9 LaTeX related options 107 20 9 LaTeX related options GENERATE_LATEX Ifthe GENERATE_LATEX tag is set to YES the default doxygen will generate IATEX output LATEX _OUTPUT The LATEX_OUTPUT tag is used to specify where the IATEX docs will be put If a relative path is entered the value of OUTPUT_DIRECTORY will be put in front of it If left blank latex will be used as the default path LATEX_CMD_NAME The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be in voked If left blank latex will be used as the default command name Note that when enabling USE_PDFL ATEX this option is only used for generating bitmaps for formulas in the HTML output but not in the Makefile that is written to the output directory MAKEINDEX_CMD_ NAME The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate index for LaTeX If left blank makeindex will be used as the default command name COMPACT_LATEX If the COMPACT_LATEX tag is set to YES doxygen generates more compact IATEX docu ments This may be useful for small projects and
164. graph Multiple adjacent retval commands will be joined into a single paragraph Each return value description will start on a new line The retval description ends when a blank line or some other sectioning command is encountered 21 78 sa references Starts a paragraph where one or more cross references to classes functions methods variables files or URL may be specified Two names joined by either or are understood as referring to a class and one of its members One of several overloaded methods or constructors may be selected by including a parenthesized list of argument types after the method name Synonymous to see See also section autolink for information on how to create links to objects Generated by Doxygen 21 79 see references 137 21 79 see references Equivalent to sa Introduced for compatibility with Javadoc 21 80 short short description Equivalent to brief 21 81 since text This tag can be used to specify since when version or time an entity is available The paragraph that follows since does not have any special internal structure All visual enhancement commands may be used inside the paragraph The since description ends when a blank line or some other sectioning command is encountered 21 82 test paragraph describing a test case Starts a paragraph where a test case can be described The description will also add the test case to a separate test list
165. group A x extern int VarInA xx defgroup IntVariables Global integer variables x an integer variable extern int IntegerVariable kx Adefgroup Variables Global variables x a variable in group A int VarInA int IntegerVariable xx x The ref command can be used to refer to a group The first argument of the ref command should be group s label To use a custom link name you can put the name of the links in double quotes after the label as shown by the following example This is the ref group_label link to this group The priorities of grouping definitions are from highest to lowest ingroup defgroup addtogroup weakgroup The last command is exactly like addtogroup with a lower priority It was added to allow lazy grouping definitions you can use commands with a higher priority in your h files to define the hierarchy and weakgroup in c files without having to duplicate the hierarchy exactly Example x defgroup groupl The First Group This is the first group xx brief class Cl in group 1 x class Cl brief class C2 in group 1 class C2 xx function in group 1 x void func xx end of groupl kx x defgroup group2 The Second Group This is the second group defgroup group3 The Third Group This is the third group Generated by Doxygen 5 2 Member Groups 45
166. gt Some context copied when condition BLOCKNAME does not hold lt END BLOCKNAME gt The following block names are supported DISABLE_INDEX Content within this block is copied to the output when the DISABLE_INDEX option is enabled so when the index is disabled GENERATE_TREEVIEW Content within this block is copied to the output when the GENERATE_TREEVIE W option is enabled SEARCHENGINE Content within this block is copied to the output when the SEARCHENGINE option is enabled PROJECT_NAME Content within the block is copied to the output when the PROJECT _NAME option is not empty PROJECT_NUMBER Content within the block is copied to the output when the PROJECT_NUMBER option is not empty PROJECT_BRIEF Content within the block is copied to the output when the PROJECT_BRIEF option is not empty PROJECT_LOGO Content within the block is copied to the output when the PROJECT _LOGO option is not empty TITLEAREA Content within this block is copied to the output when a title is visible at the top of each page This is the case if either PROJECT NAME PROJECT_BRIEF PROJECT _LOGO is filled in or if both DISABLE_INDEX and SEARCHENGINE are enabled See also section Doxygen usage for information on how to generate the default header that doxygen normally uses Note The header is subject to change so you typically have to regenerate the default header when upgrading to a newer version of doxygen HTML FOOTER The HTML_FOOTER tag
167. gt as is in the HTML documentation The command is equivalent to pasting the file in the documentation and placing htmlonly and endhtmlonly commands around it Files or directories that doxygen should look for can be specified using the EXAMPLE_PATH tag of doxygen s configuration file Commands for visual enhancements 21 111 a lt word gt Displays the argument lt word gt in italics Use this command to emphasize words Use this command to refer to member arguments in the running text Example the la x and la y coordinates are used to This will result in the following text the x and y coordinates are used to Generated by Doxygen 21 112 arg item description 145 Equivalent to e and em To emphasize multiple words use lt em gt multiple words lt em gt 21 112 larg item description This command has one argument that continues until the first blank line or until another arg is encountered The command can be used to generate a simple not nested list of arguments Each argument should start with a arg command Example Typing arg c AlignLeft left alignment arg c AlignCenter center alignment arg c AlignRight right alignment No other types of alignment are supported will result in the following text e AlignLeft left alignment e AlignCenter center alignment e AlignRight right alignment No other types of alignment are supported Note For nested lists HTML com
168. gument public method itcl_method_z arg Documented common itcl var c itcl_Var common itcl_Var protectedsection variable itcl_varl lt Documented itcl var c itcl_varl variable itcl_var2 Documented oo class c oo_class o class create oo_class Create object Configure with args constructor args eval Sargs Destroy object Exit destructor exit Documented oo var c oo_var Defined inside class variable oo_var private Documented oo method c oo_method_x param in arg Argument method oo_method_x arg protected Documented oo method c oo_method_y param in arg Argument method oo_method_y arg public Documented oo method c oo_method_z param in arg Argument method oo_method_z arg endcode itcl body ns itcl_class itcl_method_x argx oo puts Sargx OK define ns oo_class public Outside defined variable c oo_var_out Inside oo_class variable oo_var_out Documented global proc c glob_proc param in arg Argument proc glob_proc arg puts Sarg variable glob_var lt Documented global var c glob_var with newline lt and continued line 81 end of file 3 2 Anatomy of acomment block The previous section focused on how to make the comments in your code known to doxygen it explained the difference between a brief and a detailed description and the use of structural commands Generated by Doxygen 3 2
169. h a piece please send it to me so can improve doxygen s parsing capabilities Try to make the piece of code you send as small as possible to help me narrow down the search Doxygen does not work properly if there are multiple classes structs or unions with the same name in your code It should not crash however rather it should ignore all of the classes with the same name except one e Some commands do not work inside the arguments of other commands Inside a HTML link i e lt a href gt lt a gt for instance other commands including other HTML commands do not work The sec tioning commands are an important exception e Redundant braces can confuse doxygen in some cases For example void f int is properly parsed as a function declaration but const int a is also seen as a function declaration with name int because only the syntax is analyzed not the semantics If the redundant braces can be detected as in int a 20 then doxygen will remove the braces and correctly parse the result Not all names in code fragments that are included in the documentation are replaced by links for instance when using SOURCE_BROWSER YES and links to overloaded members may point to the wrong member This also holds for the Referenced by list that is generated for each function For a part this is because the code parser isn t smart enough at the moment I ll try to improve this in the future But even w
170. h again Doxygen will remove the mandatory indentation from the code block Note that you cannot start a code block in the middle of a paragraph i e the line preceding the code block must be empty See section Code Block Indentation for more info how doxygen handles indentation as this is slightly different than standard Markdown Generated by Doxygen 4 1 Standard Markdown 35 4 1 6 Horizontal Rulers A horizontal ruler will be produced for lines containing at least three or more hyphens asterisks or underscores The line may also include any amount of whitespace Examples Note that using asterisks in comment blocks does not work See Use of asterisks for details 4 1 7 Emphasis To emphasize a text fragment you start and end the fragment with an underscore or star Using two stars or underscores will produce strong emphasis Examples Single asterisksx _single underscores_ xxdouble asterisksx x double underscores See section Emphasis limits for more info how doxygen handles emphasis spans slightly different than standard Markdown 4 1 8 code spans To indicate a span of code you should wrap it in backticks Unlike code blocks code spans appear inline in a paragraph An example Use the printf function To show a literal backtick inside a code span use double backticks i e v To assign the output of command ls to var use var 1s See section Code Spans Limits for more in
171. he first line until the first dot of a Qt style comment as the brief description If set to NO the default the Qt style will behave just like regular Qt style comments thus requiring an explicit brief command for a brief description MARKDOWN_SUPPORT If MARKDOWN_SUPPORT is enabled the default then doxygen pre processes all com ments according to the Markdown format which allows for more readable documentation See http daringfireball net projects markdown for details The output of markdown process ing is further processed by doxygen so you can mix doxygen HTML and XML commands with Markdown formatting Disable only in case of backward compatibilities issues BUILTIN_STL SUPPORT If you use STL classes i e std string std vector etc but do not want to include a tag file for the STL sources as input then you should set this tag to YES in order to let doxygen match functions declarations and definitions whose arguments contain STL classes e g func std string versus func std string This also make the inheritance and collaboration diagrams that involve STL classes more complete and accurate Generated by Doxygen 20 2 Project related options 95 CPP_CLI_SUPPORT lf you use Microsoft s C CLI language you should set this option to YES to enable pars ing support SIP_SUPPORT Set the SIP_SUPPORT tag to YES if your project consists of sip sources only Doxygen will parse them like normal C but will ass
172. icular method What says the base class of a language translator If the language translator class inherits from any adapter class the maintenance is needed In such case the language translator is not considered up to date On the other hand if the language translator derives directly from the abstract class Translator the language translator is up to date The translator adapter classes are chained so that the older translator adapter class uses the one step newer translator adapter as the base class The newer adapter does less adapting work than the older one The oldest adapter class derives indirectly from all of the adapter classes The name of the adapter class is chosen so that its suffix is derived from the previous official version of doxygen that did not need the adapter This way one can say approximately when the language translator class was last updated see details below The newest translator adapter derives from the abstract TranslatorAdapterBase class that derives directly from the abstract Translator class It adds only the private English translator member for easy implementation of the default translation inside the adapter classes and it also enforces implementation of one method for noticing the user that the language translation is not up to date because of that some sentences in the generated files may appear in English Generated by Doxygen 177 Once the oldest adapter class is not used by any of the la
173. ile that captures the structure of the code including all documentation XML_OUTPUT The XML_OUTPUT tag is used to specify where the XML pages will be put If a relative path is entered the value of OUTPUT_DIRECTORY will be put in front of it If left blank xm1 will be used as the default path XML_SCHEMA The XML_SCHEMA tag can be used to specify an XML schema which can be used by a validating XML parser to check the syntax of the XML files XML_DTD The XML_DTD tag can be used to specify an XML DTD which can be used by a validating XML parser to check the syntax of the XML files XML_PROGRAMLISTING If the XML PROGRAMLISTING tag is set to YES Doxygen will dump the program listings including syntax highlighting and cross referencing information to the XML output Note that enabling this will significantly increase the size of the XML output 20 13 AUTOGEN_DEF related options GENERATE_AUTOGEN_DEF f the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will generate an AutoGen Definitions see http autogen sf net file that captures the structure of the code includ ing all documentation Note that this feature is still experimental and incomplete at the moment 20 14 PERLMOD related options GENERATE_PERLMOD lf the GENERATE_PERLMOD tag is set to YES Doxygen will generate a Perl module file that captures the structure of the code including all documentation Note that this feature is sti
174. in information is encoded using so called fields To show the actual value you need to select all Edit select all and then toggle fields right click and select the option from the drop down menu 2 3 4 XML output The XML output consists of a structured dump of the information gathered by doxygen Each compound class namespaceffile has its own XML file and there is also an index file called index xml A file called combine xslt XSLT script is also generated and can be used to combine all XML files into a single file Doxygen also generates two XML schema files index xsd for the index file and compound xsd for the compound files This schema file describes the possible elements their attributes and how they are structured i e it the describes the grammar of the XML files and can be used for validation or to steer XSLT scripts In the addon doxmlparser directory you can find a parser library for reading the XML output produced by doxygen in an incremental way see addon doxmlparser include doxmlint f h for the interface of the library 2 3 5 Man page output The generated man pages can be viewed using the man program You do need to make sure the man directory is in the man path see the MANPATH environment variable Note that there are some limitations to the capabilities of the man page format so some information like class diagrams cross references and formulas will be lost Generated by Doxygen 2 4 Step 3
175. instance somewhere on the web You may want to link to these pages instead of generating the documentation in your local output directory Compilation speed External projects typically have a different update frequency from your own project It does not make much sense to let doxygen parse the sources for these external project over and over again even if nothing has changed Memory For very large source trees letting doxygen parse all sources may simply take too much of your system s memory By dividing the sources into several packages the sources of one package can be parsed by doxygen while all other packages that this package depends on are linked in externally This saves a lot of memory Availability For some projects that are documented with doxygen the sources may just not be available Copyright issues If the external package and its documentation are copyright someone else it may be better or even necessary to reference it rather than include a copy of it with your project s documentation When the author forbids redistribution this is necessary If the author requires compliance with some license condition as a precondition of redistribution and you do not want to be bound by those conditions referring to their copy of their documentation is preferable to including a copy If any of the above apply you can use doxygen s tag file mechanism A tag file is basically a compact representation of the entities found in the
176. ion in order to regenerated the Makefiles 8 Now you can use OUTPUT_LANGUAGE your_language_name in the config file to generate output in your language 9 Send translator_xx h to me so can add it to doxygen Send also your name and e mail address to be included in the maintainers txt list Maintaining a language New versions of doxygen may use new translated sentences In such situation the Translator class requires implementation of new methods its interface changes Of course the English sentences need to be translated to the other languages At least new methods have to be implemented by the language related translator class otherwise doxygen wouldn t even compile Waiting until all language maintainers have translated the new sentences and sent the results would not be very practical The following text describes the usage of translator adapters to solve the problem The role of Translator Adapters Whenever the Translator class interface changes in the new release the new class TranslatorAdapter_x_y_z is added tothe translator_adapter h file here x y and z are numbers that correspond to the current official version of doxygen All translators that previously derived from the Translator class now derive from this adapter class The TranslatorAdapter_x_y_z Class implements the new required methods If the new method replaces some similar but obsolete method s e g if the number of arguments changed and or the functiona
177. ion to the above argument specifiers square brackets are used the argument is optional Here is an alphabetically sorted list of all commands with references to their documentation A bod oi dae ewes AA dotiile ee wk be le de 21 121 EA ena ae Pace oe de amp a 21 89 NOP Sat th tt ce See ee Oe ea ee creas Gece aa ar Gs ec 21 123 E esi cess ae ed deal eee ara we E 212 NGISE S Bus prin Ge wy deat aor tee te tad 21 58 aNGhOr cia Phe aa ef Se aG Sead Be 21 90 yelse o sais cag SY SS PSs oe ae Bet owe 21 59 Nal iaa a Bette alee a gh oft tty OS hac Roe hy hea ao PUAN NGM Sint ace ted om A ee EK cok oh ae 21 124 attention 24 22 0 ena ei Bed hee a eae 21 48 A 21 125 A oh a A Ge 21 49 Vendcond te 42 ule Shan a Ge en a 21 60 autho 2 abn a oR eed Pe e a 21 50 yenddot se ica ds ay de seh ate dt tenes 21 126 ND ea eed a SN ka BS Pie ee been Seas aan 21 113 endhtmlonly o oo oco o o o 0000 0 21 128 ADHS aa lia oe he ere Bess a tnd noel Bk 21 51 NONI masia eas are tose aoe GF ae up ak anaes ety 21 61 DUO ard teas no Da can ae Mat th Bch an el BA 21 52 Nendinternal a ara a uit ee fa hea ae a E 21 12 YO ata dad a do o da 21 114 endlatexonly so co ca ea coia a a a ooo 21 129 G llgra phi ca ci enas on ae a ui e Ka le bo tan 21 3 MONON rs ye uc its a Dt at o e ig 21 92 Acallergraph aaia a ee ee 21 4 endmanonly 2 0000 eee eee 21 130 Galegory 2 ce ae ee ee de be bee Get 215 NOMOMBO o onma e a A 21 127 NCIC Fasc i ae ache eat a
178. ique will be used STRIP_FROM_ PATH lf the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag can be used to strip a user defined part of the path Stripping is only done if one of the specified strings matches the left hand part of the path The tag can be used to show relative paths in the file list If left blank the directory from which doxygen is run is used as the path to strip STRIP_FROM_INC_PATH The STRIP_FROM_INC_PATH tag can be used to strip a user defined part of the path mentioned in the documentation of a class which tells the reader which header file to include in order to use a class If left blank only the name of the header file containing the class definition is used Otherwise one should specify the include paths that are normally passed to the compiler using the I flag SHORT_NAMES If the SHORT_NAMES tag is set to YES doxygen will generate much shorter but less readable file names This can be useful is your file systems doesn t support long names like on DOS Mac or CD ROM JAVADOC_AUTOBRIEF If the JAVADOC_AUTOBRIEF is set to YES then doxygen will interpret the first line until the first dot of a JavaDoc style comment as the brief description If set to NO the default the Javadoc style will behave just like regular Qt style comments thus requiring an explicit brief command for a brief description QT_AUTOBRIEF Ifthe OT_AUTOBRIEF is set to YES then doxygen will interpret t
179. is a string for the brief description and a string for the detailed description The documentation parser reads these strings and executes the commands it finds in it this is the second pass in parsing the documentation It writes the result directly to the output generators The parser is written in C and can be found in src docparser cpp The tokens that are eaten by the parser come from src doctokenizer Code fragments found in the comment blocks are passed on to the source parser The main entry point for the documentation parser is val idatingParseDoc declared in src docparser h For simple texts with special commands validatingParseText is used Source parser If source browsing is enabled or if code fragments are encountered in the documentation the source parser is invoked The code parser tries to cross reference to source code it parses with documented entities It also does syntax highlighting of the sources The output is directly written to the output generators The main entry point for the code parser is parseCode declared in src code h Output generators After data is gathered and cross referenced doxygen generates output in various formats For this it uses the methods provided by the abstract class Out putGenerator In order to generate output for multiple formats at once the methods of Output List are called instead This class maintains a list of concrete output generators where each method called is del
180. isabling STRICT_PROTO_MATCHING doxygen will still accept a match between prototype and implementation in such cases GENERATE _TODOLIST The GENERATE_TODOLIST tag can be used to enable YES or disable NO the todo list This list is created by putting todo commands in the documentation GENERATE TESTLIST The GENERATE_TESTLIST tag can be used to enable YES or disable NO the test list This list is created by putting test commands in the documentation GENERATE _BUGLIST The GENERATE _BUGLIST tag can be used to enable YES or disable NO the bug list This list is created by putting bug commands in the documentation ENABLED_SECTIONS The ENABLED_SECTIONS tag can be used to enable conditional documentation sec tions marked by if lt section label gt endif and cond lt section label gt endcond blocks MAX INITIALIZER_LINES The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the initial value of a variable or define can be If the initializer consists of more lines than spec ified here it will be hidden Use a value of 0 to hide initializers completely The appearance of the value of individual variables and defines can be controlled using showinitializer or hideinitializer command in the documentation SHOW_USED_FILES Set the SHOW_USED_FILES tag to NO to disable the list of files generated at the bottom of the documentation of classes and structs If set to YES the list
181. ith these improvements not everything can be properly linked to the corresponding documentation because of possible ambiguities or lack of information about the context in which the code fragment is found e It is not possible to insert a non member function f in a class A using the relates or relatesalso command if class A already has a member with name f and the same argument list e There is only very limited support for member specialization at the moment It only works if there is a special ized template class as well 82 Troubleshooting Not all special commands are properly translated to RTF e Version 1 8 6 of dot and maybe earlier versions too do not generate proper map files causing the graphs that doxygen generates not to be properly clickable PHP only Doxygen requires that all PHP statements i e code is wrapped in a functions methods otherwise you may run into parse problems How to help The development of Doxygen highly depends on your input If you are trying Doxygen let me know what you think of it do you miss certain features Even if you decide not to use it please let me know why How to report a bug Bugs are tracked in GNOME s bugzilla database Before submitting a new bug first search through the database if the same bug has already been submitted by others the doxygen product will be preselected If you believe you have found a new bug please report it If you are unsure whether or
182. itialize the system bug Not all memory is freed when deleting an object of this class x Awarning Improper use can crash your application copyright GNU Public License class SomeNiceClass 21 50 authors list of authors Equivalent to author 21 51 brief brief description Starts a paragraph that serves as a brief description For classes and files the brief description will be used in lists and at the start of the documentation page For class and file members the brief description will be placed at the declaration of the member and prepended to the detailed description A brief description may span several lines although it is advised to keep it brief A brief description ends when a blank line or another sectioning command is encountered If multiple brief commands are present they will be joined See section author for an example Synonymous to short 21 52 bug bug description Starts a paragraph where one or more bugs may be reported The paragraph will be indented The text of the paragraph has no special internal structure All visual enhancement commands may be used inside the paragraph Multiple adjacent bug commands will be joined into a single paragraph Each bug description will start on a new line Alternatively one bug command may mention several bugs The bug command ends when a blank line or some other sectioning command is encountered See section author for an example 21 53 c
183. ivalent to doing brief copybrief foo details copydetails foo See copybrief and copydetails for copying only the brief or detailed part of the comment block 21 117 copybrief lt link object gt Works in a similar way as copydoc but will only copy the brief description not the detailed documentation Generated by Doxygen 21 118 copydetails lt link object gt 147 21 118 copydetails lt link object gt Works in a similar way as copydoc but will only copy the detailed documentation not the brief description 21 119 dot Starts a text fragment which should contain a valid description of a dot graph The text fragment ends with enddot Doxygen will pass the text on to dot and include the resulting image and image map into the output The nodes of a graph can be made clickable by using the URL attribute By using the command ref inside the URL value you can conveniently link to an item inside doxygen Here is an example class B x class B LH class C class C x mainpage Class relations expressed via an inline dot graph dot digraph example node shape record fontname Helvetica fontsize 10 b label class B URL ref B c label class C URL ref C b gt c arrowhead open style dashed enddot Note that the classes in the above graph are clickable in the HTML output 21 120 msc Starts a text fragment which should contain a valid descriptio
184. just the colors in the stylesheet and background images according to this color Hue is specified as an angle on a colorwheel see http en wikipedia org wiki Hue for more information For instance the value 0 represents red 60 is yellow 120 is green 180 is cyan 240 is blue 300 purple and 360 is red again The allowed range is 0 to 359 HTML _COLORSTYLE_SAT The HTML_COLORSTYLE_SAT tag controls the purity or saturation of the colors in the HTML output For a value of O the output will use grayscales only A value of 255 will produce the most vivid colors HTML _COLORSTYLE_GAMMA The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the luminance component of the colors in the HTML output Values below 100 gradually make the output lighter whereas values above 100 make the output darker The value divided by 100 is the actual gamma applied so 80 represents a gamma of 0 8 The value 220 represents a gamma of 2 2 and 100 does not change the gamma HTML TIMESTAMP If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML page will contain the date and time when the page was generated Setting this to NO can help when comparing the output of multiple runs HTML ALIGN_MEMBERS If the HTML_ALIGN_MEMBERS tag is set to YES the members of classes files or namespaces will be aligned in HTML using tables If set to NO a bullet list will be used Note Setting this tag to NO will become obs
185. k text Starts a paragraph where one or more remarks may be entered The paragraph will be indented The text of the paragraph has no special internal structure All visual enhancement commands may be used inside the paragraph Multiple adjacent remark commands will be joined into a single paragraph Each remark will start on a new line Alternatively one remark command may mention several remarks The remark command ends when a blank line or some other sectioning command is encountered 21 73 remarks remark text Equivalent to remark 21 74 result description of the result value Equivalent to return 21 75 return description of the return value Starts a return value description for a function The text of the paragraph has no special internal structure All visual enhancement commands may be used inside the paragraph Multiple adjacent return commands will be joined into a single paragraph The return description ends when a blank line or some other sectioning command is encountered See section fn for an example 21 76 returns description of the return value Equivalent to return 21 77 retval lt return value gt description Starts a description for a function s return value with name lt return value gt followed by a description of the return value The text of the paragraph that forms the description has no special internal structure All visual enhancement commands may be used inside the para
186. l hide all undocu mented classes If set to NO the default these classes will be included in the various overviews This option has no effect if EXTRACT_ALL is enabled HIDE_FRIEND_COMPOUNDS If the HIDE_FRIEND_COMPOUNDS tag is set to YES Doxygen will hide all friend class struct union declarations If set to NO the default these declarations will be included in the documentation HIDE_IN_BODY_DOCS If the HIDE_IN_BODY_DOCS tag is set to YES Doxygen will hide any documentation blocks found inside the body of a function If set to NO the default these blocks will be appended to the function s detailed documentation block INTERNAL_DOCS The INTERNAL_DOCS tag determines if documentation that is typed after a internal com mand is included If the tag is set to NO the default then the documentation will be excluded Set it to YES to include the internal documentation CASE_SENSE_NAMES Ifthe CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file names in lower case letters If set to YES upper case letters are also allowed This is useful if you have classes or files whose names only differ in case and if your file system supports case sensitive file names Windows users are advised to set this option to NO HIDE_SCOPE_NAMES lf the HIDE_SCOPE_NAMES tag is set to NO the default then doxygen will show mem bers with their full class and namespace scopes in the d
187. lass of your translator class to some newer adapter class or directly to the Translator class If you do not have time to finish all the updates you should still start with the most radical approach as described above You can always change the base class to the translator adapter class that implements all of the not yet implemented methods If you prefer to update your translator gradually have a look at TranslatorEnglish the translator_ en h file Inside you will find the comments like new since 1 2 4 that separate always a number of methods that were implemented in the stated version Do implement the group of methods that are placed below the comment that uses the same version numbers as your translator adapter class For example your translator class have to use the TranslatorAdapter_1_2_4 if it does not implement the methods below the comment new since 1 2 4 When you implement them your class should use newer translator adapter Run the translator py script occasionally and give it your xx identification from translator_xx h to create the translator report shorter also produced faster it will contain only the information related to your translator Once you reach the state when the base class should be changed to some newer adapter you will see the note in the translator report Warning Don t forget to compile Doxygen to discover whether it is compilable The translator py does not check if everything is correct with
188. lass or namespace or in front or after one of its members Although this is often comfortable there may sometimes be reasons to put the documentation somewhere else For documenting a file this is even required since there is no such thing as in front of a file Doxygen allows you to put your documentation blocks practically anywhere the exception is inside the body of a function or inside a normal C style comment block The price you pay for not putting the documentation block directly before or after an item is the need to put a structural command inside the documentation block which leads to some duplication of information So in practice you should avoid the use of structural commands unless other requirements force you to do so Generated by Doxygen 3 1 Special comment blocks 25 Structural commands like all other commands start with a backslash 1 or an at sign if you prefer JavaDoc style followed by a command name and one or more parameters For instance if you want to document the class Test in the example above you could have also put the following documentation block somewhere in the input that is read by doxygen x class Test brief A test class A more detailed class description Here the special command class is used to indicate that the comment block contains documentation for the class Test Other structural commands are e struct to document a C struct e union to document a union
189. ld contain one or more blanks it must be surrounded by quotes Multiple lines can be concatenated by inserting a backslash as the last character of a line Environment variables can be expanded using the pattern S ENV_VARIABLE_NAME You can also include part of a configuration file from another configuration file using a INCLUDE tag as follows INCLUDE config_file_name The include file is searched in the current working directory You can also specify a list of directories that should be searched before looking in the current working directory Do this by putting a INCLUDE_PATH tag with these paths before the INCLUDE tag e g INCLUDE_PATH my_config_dir The configuration options can be divided into several categories Below is an alphabetical index of the tags that are recognized followed by the descriptions of the tags grouped by category ABBREVIATE_BRIEF 20 2 COMPACT_RIF p a eos a eh eee ee wa 20 10 ALIASES i 00 aif a e ra ahs 20 2 CPP_CLI_SUPPORT 0 20 2 ALELEXTERNALS oia a Boe Es 20 16 CREATE_SUBDIRS 0 20 2 ALPHABETICAL_INDEX 20 7 DIRECTORY_GRAPH 22 20 17 ALWAYS_DETAILED SEC 20 2 DISABLE_INDEX o ooo o 20 8 BINARY_TOC ooo 20 8 DISTRIBUTE_GROUP_DOC 20 2 BRIEF_MEMBER_DESC 20 2 DOCSET_BUNDLE_ID 0 20 8 BUILTIN STL_S
190. less of the value of CALL_GRAPH Note The completeness and correctness of the call graph depends on the doxygen code parser which is not perfect See also section callergraph 21 4 callergraph When this command is put in a comment block of a function or method and HAVE_DOT is set to YES then doxygen will generate a caller graph for that function provided the implementation of the function or method calls other documented functions The caller graph will be generated regardless of the value of CALLER_GRAPH Note The completeness and correctness of the caller graph depends on the doxygen code parser which is not perfect See also section callgraph 21 5 category lt name gt lt header file gt lt header name gt For Objective C only Indicates that a comment block contains documentation for a class category with name lt name gt The arguments are equal to the class command See also section class Generated by Doxygen 118 Special Commands 21 6 class lt name gt lt header file gt lt header name gt Indicates that a comment block contains documentation for a class with name lt name gt Optionally a header file and a header name can be specified If the header file is specified a link to a verbatim copy of the header will be included in the HTML documentation The lt header name gt argument can be used to overwrite the name of the link that is used in the class documentation to so
191. lity of the older method was changed or enriched the TranslatorAdapter_x_y_z class may use the obsolete method to Generated by Doxygen 176 Internationalization get the result which is as close as possible to the older result in the target language If it is not possible the result the default translation is obtained using the English translator which is by definition always up to date For example when the new trFile method with parameters to determine the capitalization of the first letter and the singular plural form was introduced to replace the older method trFiles without arguments the following code appeared in one of the translator adapter classes x This is the default implementation of the obsolete method used in the documentation of a group before the list of x links to documented files This is possibly localized virtual QCString trFiles return Files This is the localized implementation of newer equivalent using the obsolete method trFiles virtual QCString trFile bool first_capital bool singular if first_capital amp amp singular return trFiles possibly localized obsolete method else return english trFile first_capital singular The trFiles is not present in the TranslatorEnglish class because it was removed as obsolete How ever it was used until now and its call was replaced by trFile true false in the doxygen source files Probably
192. ll experimental and incomplete at the moment PERLMOD_LATEX If the PERLMOD_LATEX tag is set to YES Doxygen will generate the necessary Makefile rules Perl scripts and LaTeX code to be able to generate PDF and DVI output from the Perl module output PERLMOD_PRETTY Ifthe PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely formatted so it can be parsed by a human reader This is useful if you want to understand what is going on On the other hand if this tag is set to NO the size of the Perl module output will be much smaller and Perl will parse it just the same PERLMOD_MAKEVAR_ PREFIX The names of the make variables in the generated doxyrules make file are pre fixed with the string contained in PERLMOD_MAKEVAR_PREF IX This is useful so different doxyrules make files included by the same Makefile don t overwrite each other s variables 20 15 Preprocessor related options ENABLE_PREPROCESSING If the ENABLE_PREPROCESSING tag is set to Y evaluate all C preprocessor directives found in the sources and include files E S the default doxygen will MACRO_EXPANSION If the MACRO_EXPANSTON tag is set to YES doxygen will expand all macro names in the source code If set to NO the default only conditional compilation will be performed Macro expansion can be done in a controlled way by setting EXPAND_ONLY_PREDEF to YES EXPAND _O
193. lowed to run in parallel When set to 0 the default doxygen will base this on the number of processors available in the system You can set it explicitly to a value larger than 0 to get control over the balance between CPU load and processing speed DOT_FONTNAME By default doxygen will use the Helvetica font for all dot files that doxygen generates When you want a differently looking font you can specify the font name using DOT_FONTNAME You need to make sure dot is able to find the font which can be done by putting it in a standard location or by setting the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory containing the font DOT_FONTSIZE The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs The default size is 10pt DOT_FONTPATH By default doxygen will tell dot to use the output directory to look for the FreeSans ttf font which doxygen will put there itself If you specify a different font using DOT_FONTNAME you can set the path where dot can find it using this tag CLASS _ GRAPH If the CLASS GRAPH and HAVE_DOT tags are set to YES then doxygen will generate a graph for each documented class showing the direct and indirect inheritance relations Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO COLLABORATION_GRAPH lf the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxy gen will generate a graph for each documented class showing the direct and
194. ls may put the binaries in the wrong directory If you have a RPM or DEP package then please follow the standard installation procedure that is required for these packages Generated by Doxygen 1 3 Known compilation problems for UNIX 9 1 3 Known compilation problems for UNIX Qt problems The Qt include files and libraries are not a subdirectory of the directory pointed to by QTDIR on some systems for instance on Red Hat 6 0 includes are in usr include qt and libs are in usr lib The solution go to the root of the doxygen distribution and do mkdir qt cd qt in s your qt include dir here include in s your qt lib dir here lib in s your qt bin dir here bin export QTDIR SPWD If you have a csh like shell you should use setenv QTDIR SPWD instead of the export command above Now install doxygen as described above Bison problems Versions 1 31 to 1 34 of bison contain a bug that results in a compiler errors like this ce_parse cpp 348 member class CPPValue yyalloc yyvs with constructor not allowed in union This problem has been solved in version 1 35 versions before 1 31 will also work Latex problems The file a4wide st y is not available for all distributions If your distribution does not have it please select another paper type in the config file see the PAPER_TYPE tag in the config file HP UX amp Digital UNIX problems If you are compiling for HP UX with aCC and you get this error opt aCC l
195. lso busy doing other things so if you want to help to speed things up please let them or me know If you want to add support for a language that is not yet listed please read the next section Adding a new language to doxygen This short HOWTO explains how to add support for the new language to Doxygen Just follow these steps 1 Tell me for which language you want to add support If no one else is already working on support for that language you will be assigned as the maintainer for the language 2 Create a copy of translator_en h and name it translator_ lt your_2_letter_country_code gt h I ll use xx in the rest of this document 3 Add definition of the symbol for your language in the configure at two places in the script a After the _langs is statement in lower case b In the string that following al1lowed in upper case The rerun the configure script such that is generates src lang_cfg h This file should now contain a define for your language code 4 Edit language cpp Add a ifdef LANG_xx include lt translator_xx h gt tendif Generated by Doxygen 175 Remember to use the same symbol LANG_xx that you added to lang_cfg h l e the xx should be capital letters that identify your language On the other hand the xx inside your translator_xx h should use lower case Now in setTranslator add ifdef LANG_xx else if L_EQUAL your_language_name theTranslator new TranslatorYo
196. lt paragraph name gt paragraph title Creates a named paragraph with name lt paragraph name gt The title of the paragraph should be specified as the second argument of the paragraph command Warning This command only works inside a subsubsection of a related page documentation block and not in other documentation blocks Commands for displaying examples 21 101 dontinclude lt file name gt This command can be used to parse a source file without actually verbatim including it in the documentation as the include command does This is useful if you want to divide the source file into smaller pieces and add documentation between the pieces Source files or directories can be specified using the EXAMPLE_PATH tag of doxygen s configuration file The class and member declarations and definitions inside the code fragment are remembered during the parsing of the comment block that contained the dontinclude command For line by line descriptions of source files one or more lines of the example can be displayed using the line skip skipline and until commands An internal pointer is used for these commands The dontinclude command sets the pointer to the first line of the example Example A test class class Test public Generated by Doxygen 142 Special Commands a member function void example page example x Adontinclude example_test cpp Our main function starts like this
197. macro definitions e Section Automatic link generation shows how to put links to files classes and members in the documentation e Section Output Formats shows how to generate the various output formats supported by doxygen e Section Searching shows various ways to search in the HTML documentation e Section Customizing the output explains how you can customize the output generated by doxygen e Section Custom Commands show how to define and use custom commands in your comments e Section Linking to external documentation explains how to let doxygen create links to externally generated documentation Section Frequently Asked Questions gives answers to frequently asked questions e Section Troubleshooting tells you what to do when you have problems second part forms a reference manual e Section Features presents an overview of what doxygen can do Generated by Doxygen 2 CONTENTS e Section Doxygen usage shows how to use the doxygen program e Section Doxywizard usage shows how to use the doxywizard program e Section Configuration shows how to fine tune doxygen so it generates the documentation you want e Section Special Commands shows an overview of the special commands that can be used within the docu mentation Section HTML Commands shows an overview of the HTML commands that can be used within the documen tation e Section XML Commands shows an overview of the C style XML commands that can be used within the
198. made using foo whereas foo will link to the member For non overloaded members the argument list may be omitted If a function is overloaded and no matching argument list is specified i e pattern 2 or 6 is used a link will be created to the documentation of one of the overloaded members For member functions the class scope as used in patterns 4 to 7 may be omitted if 1 The pattern points to a documented member that belongs to the same class as the documentation block that contains the pattern 2 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 9 5 Links to other members 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 patterns 3 and 7 in this case Example x file autolink cpp Testing automatic link generation A link to a member of the Test class Test member More specific links to the each of the overloaded members Test member int and Test member int int A link to a protected member variable of Test Test var A link to the global enumeration type GlobEnum A link to the define ABS x Generated by Doxygen 9 5 Links to other members 61 A link to the destructor of the Test class Test Test A link to the typedef B A link to the enumeration type Test EType A link to some en
199. make sure you do include freetype support which requires the freetype library and header files otherwise the graphs will not render proper text labels e For formulas or if you do not wish to use pdflatex the ghostscript interpreter is needed You can find it at www ghostscript com In order to generate doxygen s own documentation Python is needed you can find it at www python org Compilation is now done by performing the following steps 1 Unpack the archive unless you already have done that gunzip doxygen VERSION src tar gz uncompress the archive tar xf doxygen SVERSION src tar unpack it 2 Run the configure script sh configure The script tries to determine the platform you use the make tool which must be GNU make and the perl interpreter It will report what it finds To override the auto detected platform and compiler you can run configure as follows 8 Installation configure platform platform type See the PLATFORMS file for a list of possible platform options If you have Qt 4 3 or higher installed and want to build the GUI front end you should run the configure script with the with doxywizard option configure with doxywizard For an overview of other configuration options use configure help 3 Compile the program by running make make The program should compile without problems and the binaries doxygen and optionally doxywizard should be available in the bin directory of the
200. mands should be used Equivalent to li 21 113 Ab lt word gt Displays the argument lt word gt using a bold font Equivalent to lt b gt word lt b gt To put multiple words in bold use lt b gt multiple words lt b gt 21 114 Ac lt word gt Displays the argument lt word gt using a typewriter font Use this to refer to a word of code Equivalent to lt tt gt word lt tt gt Example Typing This function returns c void and not c int will result in the following text This function returns void and not int Equivalent to p To have multiple words in typewriter font use lt tt gt multiple words lt tt gt Generated by Doxygen 146 Special Commands 21 115 code lt word gt Starts a block of code A code block is treated differently from ordinary text It is interpreted as source code The names of classes and members and other documented entities are automatically replaced by links to the documentation By default the language that is assumed for syntax highlighting is based on the location where the code block was found If this part of a Python file for instance the syntax highlight will be done according to the Python syntax If it unclear from the context which language is meant for instance the comment is in a txt or markdown file then you can also explicitly indicate the language by putting the file extension typically that doxygen associated with the language in curly
201. markers You will get an error message when you use the same group label more than once If you don t want doxygen to enforce unique labels then you can use addtogroup instead of defgroup It can be used exactly like defgroup but when the group has been defined already then it silently merges the existing documentation with the new one The title of the group is optional for this command so you can use x addtogroup lt label gt xx to add additional members to a group that is defined in more detail elsewhere Note that compound entities like classes files and namespaces can be put into multiple groups but members like variable functions typedefs and enums can only be a member of one group this restriction is in place to avoid ambiguous linking targets in case a member is not documented in the context of its class namespace or file but only visible as part of a group Doxygen will put members into the group whose definition has the highest priority e g An explicit ingroup overrides an implicit grouping definition via Conflicting grouping definitions with the same priority trigger a warning unless one definition was for a member without any explicit documentation 44 Grouping The following example puts VarInA into group A and silently resolves the conflict for IntegerVariable by putting it into group IntVariables because the second instance of IntegerVariable is undocumented Vik x in
202. ment should be a single word identifier See also page Grouping sections ingroup addtogroup and weakgroup Generated by Doxygen 21 9 dir lt path fragment gt 119 21 9 A dir lt path fragment gt Indicates that a comment block contains documentation for a directory The path fragment argument should include the directory name and enough of the path to be unique with respect to the other directories in the project The SHOW_DIRECTORIES option determines whether or not the directory information is shown and the STRIP_ FROM_PATH option determines what is stripped from the full path before it appears in the output 21 10 enum lt name gt Indicates that a comment block contains documentation for an enumeration with name lt name gt If the enum is a member of a class and the documentation block is located outside the class definition the scope of the class should be specified as well If a comment block is located directly in front of an enum declaration the enum comment may be omitted Note The type of an anonymous enum cannot be documented but the values of an anonymous enum can Example class Test public enum TEnum Vall Val2 Another enum with inline docs enum AnotherEnum V1 lt value 1 V2 x lt value 2 y y x class Test The class description x Nenum Test TEnum x A description of the enum type x Nvar Test TEnum Test Vall
203. mentation fragment that is meant for internal use only The fragment naturally ends at the end of the comment block You can also force the internal section to end earlier by using the endinternal command If the internal command is put inside a section see for example section all subsections after the command are considered to be internal as well Only a new section at the same level will end the fragment that is considered internal You can use INTERNAL_DOCS in the config file to show Y1 Gl S or hide NO the internal documentation See also section endinternal 21 22 mainpage title If the mainpage command is placed in a comment block the block is used to customize the index page in HTML or the first chapter in ATEX The title argument is optional and replaces the default title that doxygen normally generates If you do not want any title you can specify not it le as the argument of mainpage Here is an example x mainpage My Personal Index Page section intro_sec Introduction This is the introduction section install_sec Installation subsection stepl Step 1 Opening the box SEC F F FH HF OF You can refer to the main page using ref index See also section section section subsection and section page 21 23 memberof lt name gt This command makes a function a member of a class in a similar way as relates does only with this command the function is represented
204. mething other than lt header file gt This can be useful if the include name is not located on the default include path like lt X11 X h gt With the lt header name gt argument you can also specify how the include statement should look like by adding either quotes or sharp brackets around the name Sharp brackets are used if just the name is given Note that the last two arguments can also be specified using the headerfile command Example A dummy class x class Test y x class Test class h inc class h x brief This is a test class x Some details about the Test class 21 7 def lt name gt Indicates that a comment block contains documentation for a define macro Example x file define h brief testing defines This is to test the documentation of defines e def MAX x y Computes the maximum of Na x and la y x Computes the absolute value of its argument a x define ABS x x gt 0 x x define MAX x y x gt y x y define MIN x y x gt y y x x 1 lt Computes the minimum of Na x and la y x 21 8 defgroup lt name gt group title Indicates that a comment block contains documentation for a group of classes files or namespaces This can be used to categorize classes files or namespaces and document those categories You can also use groups as members of other groups thus building a hierarchy of groups The lt name gt argu
205. n abstract base class called TUnknown A reference to an IID x ifdef _ cplusplus define REFIID const IID else define REFIID const IID gt x endif x The IUnknown interface x DECLARE_INTERFACE IUnknown STDMETHOD HRESULT QueryInterface THIS_ REFIID iid void x ppv PURE STDMETHOD ULONG AddRef THIS PURE STDMETHOD ULONG Release THIS PURE y without macro expansion doxygen will get confused but we may not want to expand the REFIID macro because it is documented and the user that reads the documentation should use it when implementing the interface By setting the following in the config file ENABLE_PREPROCESSING YES MACRO_EXPANSION YES EXPAND_ONLY_PREDEF YES PREDEFINED DECLARE_INTERFACE name class name STDMETHOD result name virtual result name PURE 0 THIS_ THIS _ cplusplus we can make sure that the proper result is fed to doxygen s parser A reference to an IID x define REFIID x The IUnknown interface class IUnknown virtual HRESULT QueryInterface REFIID iid void ppv 0 virtual ULONG AddRef 0 virtual ULONG Release 0 y Note that the PREDEFINED tag accepts function like macro definitions like DECLARE_INTERFACE normal macro substitutions like PURE and THIS and plain defines like ___ cplusplus Note also that preprocessor definitions that are normally defined automatically by the
206. n an alias for the command xrefitem todo Todo Todo List Since it is very tedious and error prone to repeat the first three parameters of the command for each section the command is meant to be used in combination with the ALIASES option in the configuration file To define a new command reminder for instance one should add the following line to the configuration file ALIASES reminder xrefitem reminders Reminder Reminders Note the use of escaped quotes for the second and third argument of the xrefitem command Commands to create links 21 89 laddindex text This command adds text to the IATEX index 21 90 anchor lt word gt This command places an invisible named anchor into the documentation to which you can refer with the ref command Note Anchors can currently only be put into a comment block that is marked as a page using page or mainpage mainpage Generated by Doxygen 21 91 cite lt label gt 139 See also section ref 21 91 cite lt label gt Adds a bibliographic reference in the text and in the list of bibliographic references The lt label gt must be a valid Bib TeX label that can be found in one of the bib files listed in CITE_BIB_FILES For the LaTeX output the formatting of the reference in the text can be configured with LATEX_BIB_STYLE For other output formats a fixed representation is used Note that using this command requires the bibtex tool to be present
207. n of a message sequence chart See http www mcternan me uk mscgen for examples The text fragment ends with endmsc Note The text fragment should only include the part of the message sequence chart that is within the msc block You need to install the ms cgen tool if you want to use this command Here is an example of the use of the msc command x x Sender class Can be used to send a command to the server The receiver will acknowledge the command by calling Ack msc Sender Receiver Sender gt Receiver label Command URL ref Receiver Command Sender lt Receiver label Ack URL ref Ack ID 1 endmsc class Sender public x Acknowledgement from server x void Ack bool ok x Receiver class Can be used to receive and execute commands After execution of a command the receiver will send an acknowledgement msc Generated by Doxygen 148 Special Commands Receiver Sender Receiver lt Sender label Command URL Xref Command Receiver gt Sender label Ack URL ref Sender Ack ID 1 endmsc class Receiver public x Executable a command on the server x void Command int commandld See also section mscfile 21 121 dotfile lt file gt caption Inserts an image generated by dot from lt file gt into the documentation The first argument specifies the file name of the image doxygen will look for
208. n the result set lt param gt lt param name searchString gt The text that we are searching for lt param gt lt returns gt A DataSet instance containing the matching rows It contains a maximum number of rows specified by the maxRows parameter lt returns gt public DataSet Search string connectionString int maxRows int searchString DataSet ds new DataSet return ds Generated by Doxygen Part Ill Developers Manual Chapter 24 Doxygen s internals Doxygen s internals Note that this section is still under construction The following picture shows how source files are processed by doxygen config file Config parser input files C Preprocessor Language parser string tag file parser Data organiser Source Parser drives Me Doc Parser drives drives Figure 24 1 Data flow overview The following sections explain the steps above in more detail Config parser The configuration file that controls the settings of a project is parsed and the settings are stored in the singleton class Config insrc config h The parser itself is written using flex and can be found in src config 1 This parser is also used directly by doxywizard so it is put in a separate library Each configuration option has one of 5 possible types String List Enum Int or Bool The values of these 166 Doxygen s internals options are available thr
209. n will strip the other stars as well making the list disappear Rulers created with s will not be visible at all They only work in Markdown files Generated by Doxygen 4 4 Debugging of problems 41 4 3 8 Limits on markup scope To avoid that a stray or _ matches something many paragraphs later and shows everything in between with emphasis doxygen limits the scope of a x and _ to a single paragraph For a code span between the starting and ending backtick only two new lines are allowed Also for links there are limits the link text and link title each can contain only one new line the URL may not contain any newlines 4 4 Debugging of problems When doxygen parses the source code it first extracts the comments blocks then passes these through the Mark down preprocessor The output of the Markdown preprocessing consists of text with special commands and HTML commands A second pass takes the output of the Markdown preprocessor and converts it into the various output formats During Markdown preprocessing no errors are produced Anything that does nat fit the Markdown syntax is simply passed on as is In the subsequent parsing phase this could lead to errors which may not always be obvious as they are based on the intermediate format To see the result after Markdown processing you can run doxygen with the d Markdown option It will then print each comment block before and after Markdown processing Generated by
210. nclude relations of the files inside the directories Some elements have a visible attribute which can be used to hide the fragment from the generated output by setting the attribute s value to no You can also use the value of a configuration option to determine the visibility by using its name prefixed with a dollar sign e g lt includes visible SHOW_INCLUDE_FILES gt This was mainly added for backward compatibility Note that the visible attribute is just a hint for doxygen If no relevant information is available for a certain piece it is omitted even if it is set to yes i e no empty sections are generated Some elements have a title attribute This attribute can be used to customize the title doxygen will use as a header for the piece Warning at the moment you should not remove elements from the layout file as a way to hide information Doing so can cause broken links in the generated output 123 Using the XML output If the above two methods still do not provide enough flexibility you can also use the XML output produced by doxygen as a basis to generate the output you like To do this set GENERATE_XML to YES The XML output consists of an index file named index xm1 which lists all items extracted by doxygen with references to the other XML files for details The structure of the index is described by a schema file index xsd All other XML files are described by the schema file named compound xsd If you prefer one big
211. nd is encountered See section fn for an example Generated by Doxygen 21 63 if lt section label gt 133 21 63 Mif lt section label gt Starts a conditional documentation section The section ends with a matching endif command A conditional section is disabled by default To enable it you must put the section label after the ENABLED_SECTIONS tag in the configuration file Conditional blocks can be nested A nested section is only enabled if all enclosing sections are enabled as well Example Unconditionally shown documentation if Condl Only included if Condl is set endif if Cond2 Only included if Cond2 is set yif Cond3 Only included if Cond2 and Cond3 are set endif More text endif Unconditional text F FF F F HF OF N You can also use conditional commands inside aliases To document a class in two languages you could for instance use Example 2 english This is English endenglish dutch Dit is Nederlands enddutch x class Example y Where the following aliases are defined in the configuration file ALIASES english 1if english endenglish endif dutch if dutch enddutch endif T and ENABLED_SECTIONS can be used to enable either english or dutch See also sections endif ifnot else and elseif 21 64 ifnot lt section label gt Starts a conditional documentation section The section ends with a
212. ndication of the type of members that the element represents Generated by Doxygen 12 3 Using the XML output 71 memberdef Represents the detailed member list on a page member definition Like the memberdec1 ele ment also this element has a number of possible child elements The class page has the following specific elements includes Represents the include file needed to obtain the definition for this class inheritancegraph Represents the inheritance relations for a class Note that the CLASS_DIAGRAM option determines if the inheritance relation is a list of base and derived classes or a graph collaborationgraph Represents the collaboration graph for a class allmemberslink Represents the link to the list of all members for a class usedfiles Represents the list of files from which documentation for the class was extracted The file page has the following specific elements includes Represents the list of include statements contained in this file includegraph Represents the include dependency graph for the file includedbygraph Represents the included by dependency graph for the file sourcelink Represents the link to the source code of this file The group page has a specific groupgraph element which represents the graph showing the dependencies between groups Similarly the directory page has a specific directorygraph element which represents the graph showing the dependencies between the directories based on the i
213. ne will roughly double the memory usage The cache size is given by this formula 2 16 SYMBOL_CACHE_SIZE The valid range is 0 9 the default is 0 corresponding to a cache size of 21 65536 symbols LOOKUP_CACHE_ SIZE Similar to the SYMBOL_CACHE_STIZE the size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE This cache is used to resolve symbols given their name and scope Since this can be an expensive process and often the same symbol appear multiple times in the code doxygen keeps a cache of pre resolved symbols If the cache is too small doxygen will become slower If the cache is too large memory is wasted The cache size is given by this formula 2 16 LOOKUP_CACHE_SIZE The valid range is 0 9 the default is O corresponding to a cache size of 2 65536 symbols 20 3 Build related options EXTRACT_ALL If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in documentation are documented even if no documentation was available Private class members and static file members will be hidden unless the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES Note This will also disable the warnings about undocumented members that are normally produced when WARNINGS is set to YES EXTRACT_PRIVATE Ifthe EXTRACT_PRIVATE tag is set to YES all private members of a class will be included in the documentation EXTRACT_STATIC If the EXTRACT_STA
214. ng Allows inclusion of function member class definitions in the documentation All options are read from an easy to edit and optionally annotated configuration file Documentation and search engine can be transferred to another location or machine without regenerating the documentation Supports many different character encodings and uses UTF 8 internally and for the generated output Doxygen can generate a layout which you can use and edit to change the layout of each page There more than a 100 configurable options to fine tune the output Can cope with large projects easily Although doxygen can now be used in any project written in a language that is supported by doxygen initially it was specifically designed to be used for projects that make use of Qt Software s Ot toolkit have tried to make doxygen Qt compatible That is Doxygen can read the documentation contained in the Qt source code and create a class browser that looks quite similar to the one that is generated by Qt Software Doxygen understands the C extensions used by Qt such as signals and slots and many of the markup commands used in the Qt sources Doxygen can also automatically generate links to existing documentation that was generated with Doxygen or with Qt s non public class browser generator For a Qt based project this means that whenever you refer to members or classes belonging to the Qt toolkit a link will be generated to the Qt documentation This is d
215. nguage translators it can be removed from the doxygen project The maintainers should try to reach the state with the minimal number of translator adapter classes To simplify the maintenance of the language translator classes for the supported languages the translator py Python script was developed located in doxygen doc directory It extracts the impor tant information about obsolete and new methods from the source files for each of the languages The information is stored in the translator report ASCII file translator_report txt Looking at the base class of the language translator the script guesses also the status of the translator see the last column of the table with languages above The translator py is called automatically when the doxygen documentation is generated You can also run the script manually whenever you feel that it can help you Of course you are not forced to use the results of the script You can find the same information by looking at the adapter class and its base classes How should update my language translator Firstly you should be the language maintainer or you should let him her know about the changes The following text was written for the language maintainers as the primary audience There are several approaches to be taken when updating your language If you are not extremely busy you should always chose the most radical one When the update takes much more time than you expected you can always de
216. nt virtual void testMeToo char cl char c2 0 A public variable x Details int publicVar A function variable x Details int handler int a int b y The brief descriptions are included in the member overview of a class namespace or file and are printed using a small italic font this description can be hidden by setting BRIEF_MEMBER_DESC to NO in the config file By default the brief descriptions become the first sentence of the detailed descriptions but this can be changed by setting the REPEAT_BRIEF tag to NO Both the brief and the detailed descriptions are optional for the Qt style By default a JavaDoc style documentation block behaves the same way as a Qt style documentation block This is not according the JavaDoc specification however where the first sentence of the documentation block is automati cally treated as a brief description To enable this behavior you should set JAVADOC_ AUTOBRIEF to YES in the configuration file If you enable this option and want to put a dot in the middle of a sentence without ending it you should put a backslash and a space after it Here is an example x Brief description e g using only a few words Details follow Here is the same piece of code as shown above this time documented using the JavaDoc style and JAVADOC_A UTOBRIEF set to YES xx A test class A more elaborate class description class Test public rx An enum
217. nt the semantics of each node of the documentation tree For this purpose Doxygen generates a Doxy Model pm file which contains a data structure describing the type and children of each node in the documentation tree The rest of this section is to be written yet but in the meantime you can look at the Perl scripts generated by Doxygen such as doxylatex pl or doxytemplate latex pl to get an idea on how to use DoxyModel pm Generated by Doxygen 172 Perl Module Output format Generated by Doxygen Chapter 26 Internationalization Support for multiple languages Doxygen has built in support for multiple languages This means that the text fragments generated by doxygen can be produced in languages other than English the default The output language is chosen through the configuration file with default name and known as Doxyfile Currently version 1 7 6 1 39 languages are supported sorted alphabetically Afrikaans Arabic Armenian Brazilian Portuguese Catalan Chinese Chinese Traditional Croatian Czech Danish Dutch English Esperanto Finnish French German Greek Hungarian Indonesian Italian Japanese En Korean En Lithuanian Mace donian Norwegian Persian Polish Portuguese Romanian Russian Serbian SerbianCyrilic Slovak Slovene Spanish Swedish Turkish Ukrainian and Vietnamese The table of information related to the supported languages follows It is sorted by language alphabetically
218. ntinclude lt tile name gt o 141 21 102 cla HE HAMES ca A AA A cae ee 142 21 103 Vinoludelineno lt fle name gt oo ee a ee 142 Generated by Doxygen CONTENTS 9 21 104 line panon e cea ee SG ee rd a ew 143 PUTOS MIT ANGI coc ous eon See Be ee wR Re eS ere ee oe hee ee eS 143 21 106 skiplinaT pa o lt o ceos as des a 45 Ge eee ee Pe ee eS Bee we eS 143 21 107 snippet lt filename gt block_id 2 o oo 143 21 108 uni patemi sec eeue b hehe ee dd ee A ld eo Aes 144 21 109 verbinclude lt file name gt ee 144 21 110 hitilindude Meneame opio dr ae ee ee bee eee a eS 144 PLAT A OS 2 ne he hE ee ee A ew i a Be od wale ee ee GS 144 2 112 arg t temdesciipton o e 2 202 2a a 2 eR eRe eM RAE RE HE ae RR eS 145 PLAT o 6 bee PEA E e See DL RR eee eee E ES Ee og EE AS ie os 145 PUTTS OWI Sd a A A Be kd ee eR es eee eee ee 145 Si lie ode Ps wade 6 ee eee See heh ae eS ee ee ER ee bea Ba ee eS 146 21 116 copydoc lt link object gt 2 2 ee 146 21 117 copybrief lt link object gt 2 2 ee 146 21 118 copydetails lt link object gt o 147 PUTE eh ee bok at ee ae at SO e a se ee ee ee 147 PLA eho he eR a a ew ee EE ee Ea Re Ee See aa ee ee es 147 21121 daie Me A ine x ae eee ae A a ee RAR Ae a Eee da 148 21 122 msofle lt file gt eaption 2 cs ore a i pee Pe See a he ee eb Pee dae 148 Bie SRO 6 oe Bg Gb ea Ea eS he RES ae eee ie oe hn we ews 148 LTL EW WOM cet a
219. o add a patch for a bug If you do so please use PATCH as a keyword in the bug entry form If you have ideas how to fix existing bugs and limitations please discuss them on the developers mailing list subscription required Patches can also be sent directly to dimit ri stack n1 if you prefer not to send them via the bug tracker or mailing list For patches please use diff uN or include the files you modified If you send more than one file please tar or zip everything so only have to save and download one file Generated by Doxygen Part Il Reference Manual Chapter 17 Features Requires very little overhead from the writer of the documentation Plain text will do Markdown is support and for more fancy or structured output HTML tags and or some of doxygen s special commands can be used Cross platform works on Windows and many Unix flavors including Linux and MacOSX Indexes organizes and generates browsable and cross referenced output even from undocumented code Generates structured XML output for parsed sources which can be used by external tools Supports C C Java Corba and Microsoft Java Python VHDL PHP IDL C Fortran TCL Objective C 2 0 and to some extent D sources Supports documentation of files namespaces packages classes structs unions templates variables func tions typedefs enums and defines JavaDoc 1 1 qdoc3 partially and ECMA 334 C spec compatible Comes with a GU
220. o the protected class marker in C Indicates that the member documented in the comment block is protected i e should only be accessed by other members in the same or derived classes Generated by Doxygen 21 35 protocol lt name gt lt header file gt lt header name gt 127 See also sections memberof public private and protected 21 35 protocol lt name gt lt header file gt lt header name gt Indicates that a comment block contains documentation for a protocol in Objective C with name lt name gt The arguments are equal to the class command See also section class 21 36 public Indicates that the member documented in the comment block is public i e can be accessed by any other class or function Note that Doxygen automatically detects the protection level of members in object oriented languages This com mand is intended for use only when the language does not support the concept of protection level natively e g C PHP 4 For starting a section of public members in a way similar to the public class marker in C use publicsection See also sections memberof protected private and publicsection 21 37 publicsection Starting a section of public members in a way similar to the public class marker in C Indicates that the member documented in the comment block is public i e can be accessed by any other class or function See also sections memberof pro
221. ocumentation If set to YES the scope will be hidden SHOW_INCLUDE_FILES If the SHOW_INCLUDE_FILES tag is set to YES the default then doxygen will put a list of the files that are included by a file in the documentation of that file FORCE_LOCAL INCLUDES Ifthe FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen will list include files with double quotes in the documentation rather than with sharp brackets INLINE_INFO lf the INLINE_INFO tag is set to YES the default then a tag inline is inserted in the docu mentation for inline members SORT_MEMBER_ DOCS f the SORT_MEMBER_DOCS tag is set to YES the default then doxygen will sort the detailed documentation of file and class members alphabetically by member name If set to NO the members will appear in declaration order SORT_BRIEF_DOCS lf the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief descriptions of file namespace and class members alphabetically by member name If set to NO the default the members will appear in declaration order SORT_GROUP_NAMES If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy of group names into alphabetical order If set to NO the default the group names will appear in their defined order SORT_BY_ SCOPE_NAME Ifthe SORT_BY_SCOPE_NAME tag is set to YES the class list will be sorted by fully qualified names including namespaces If set
222. ocumentation by setting INLINE SOURCES to YES this can be handy for code reviews for instance 2 3 Step 2 Running doxygen To generate the documentation you can now enter doxygen lt config file gt Depending on your settings doxygen will create html rtf latex xml and or man directories inside the output directory As the names suggest these directories contain the generated documentation in HTML RTF ATEX XML and Unix Man page format The default output directory is the directory in which doxygen is started The root directory to which the output is written can be changed using the OUTPUT_DIRECTORY The format specific directory within the output directory can be selected using the HTML_OUTPUT RTF_OUTPUT LATEX_OUTPUT XML_OUTPUT and MAN_OUTP UT tags of the configuration file If the output directory does not exist doxygen will try to create it for you but it will not try to create a whole path recursively like mkdir p does Generated by Doxygen 16 Getting Started 2 3 1 HTML output The generated HTML documentation can be viewed by pointing a HTML browser to the index html file in the html directory For the best results a browser that supports cascading style sheets CSS should be used I m using Mozilla Firefox Google Chrome Safari and sometimes IE8 IE9 and Opera to test the generated output Some of the features the HTML section such as GENERATE_TREEVIEW or the search engine require a browser that
223. ocumentation consistent with the source code You can configure doxygen to extract the code structure from undocumented source files This is very useful to quickly find your way in large source distributions You can also visualize the relations between the various elements by means of include dependency graphs inheritance diagrams and collaboration diagrams which are all generated automatically 3 You can also use doxygen for creating normal documentation as did for this manual Doxygen is developed under Linux and Mac OS X but is set up to be highly portable As a result it runs on most other Unix flavors as well Furthermore executables for Windows are available This manual is divided into three parts each of which is divided into several sections The The first part forms a user manual e Section Installation discusses how to download compile and install doxygen for your platform e Section Getting started tells you how to generate your first piece of documentation quickly Section Documenting the code demonstrates the various ways that code can be documented e Section Markdown support show the Markdown formatting supported by doxygen e Section Grouping shows how to group things together e Section Including formulas shows how to insert formulas in the documentation Section Graphs and diagrams describes the diagrams and graphs that doxygen can generate e Section Preprocessing explains how doxygen deals with
224. oi epa daoa Pee E E ae ee S 137 Ue RT ie Be et ey A a ee Eee ae 137 21 82 test paragraph describing a test case o o e 137 21 83 throw lt exception object gt exception description o oo eo 137 21 84 throws lt exception object gt exception description o o o e 137 21 85 todo paragraph describing what is to be done o o 137 21 86 Iversion Version number 137 21 87 warning warning Message 138 21 88 xrefitem lt key gt heading list title text o o o o o oo 138 LES addindex let 5 ee do as ee a e ee eS 138 ARO SA WON lt a io he Bas a REE we eS ARGOS BEE ea at 138 SU Vole label or eh A eh ee be ee a OEE A PET ds Oe Ee Ped eee eet 139 Oa ee Ae oS ara ede BL ee AOE ON ee eee EG ae es ae 139 21939 NN RRO lt roo Oe eh a be ee A A ee ee 139 21 94 iet nainie gt SU ws vee he ee ee ES bee ab ee eee be eee 139 2195 sulpage chame TUS 2 6 eee Ot mee eG HE RARER ERE ERE EES 139 21 06 tableoicontenis 2 2 5 0 4d bea eR wee A oe ees 140 21 97 section lt section name gt section title o o 140 21 98 subsection lt subsection name gt subsection title o o o o 140 21 99 subsubsection lt subsubsection name gt subsubsection title o o 141 21 100 paragraph lt paragraph name gt paragraph title o o o 141 21 101 do
225. olete in the future since only intent to support and test the aligned representation HTML _DYNAMIC_SECTIONS Ifthe HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML documentation will contain sections that can be hidden and shown after the page has loaded For this to work a browser that supports JavaScript and DHTML is required for instance Mozilla 1 0 Firefox Netscape 6 0 Internet explorer 5 0 Konqueror or Safari GENERATE _DOCSET If the GENERATE_DOCSET tag is set to YES additional index files will be generated that can be used as input for Apple s Xcode 3 integrated development environment intro duced with OSX 10 5 Leopard To create a documentation set doxygen will generate a Makefile in the HTML output directory Running make will produce the docset in that directory and running make install will install the docset in Library Developer Shared Documentation DocSets so that Xcode will find it at startup See this article for more information DOCSET_FEEDNAME When GENERATE_DOCSET tag is set to YES this tag determines the name of the feed A documentation feed provides an umbrella under which multiple documentation sets from a single provider such as a company or product suite can be grouped DOCSET_BUNDLE_ID When GENERATE_DOCSET tag is set to YES this tag specifies a string that should uniquely identify the documentation set bundle This should be a reverse dom
226. ond lt section label gt Starts a conditional section that ends with a corresponding endcond command which is typically found in another comment block The main purpose of this pair of commands is to conditionally exclude part of a file from processing in older version of doxygen this could only be achieved using C preprocessor commands The section between cond and endcond commands can be included by adding its section label to the ENABL ED_SECTIONS configuration option If the section label is omitted the section will be excluded from processing unconditionally For conditional sections within a comment block one should use a if endif block Conditional sections can be nested In this case a nested section will only be shown if it and its containing section are included Here is an example showing the commands in action xx An interface x class Intf public x A method virtual void func 0 Generated by Doxygen 21 54 copyright copyright description 131 cond TEST x A method used for testing virtual void test 0 Rendcond y cond DEV The implementation of the interface class Implementation public Intf public void func cond TEST void test endcond cond x x This method is obsolete and does not show up in the documentation void obsolete endcond y endcond The output will be dif
227. ond input sel in std_logic Select input mux_out out std_logic Mux output i end entity brief Architure definition of the MUX details More details about this mux element architecture behavior of mux_using_with is begin with sel select mux_out lt din_0 when 0 din_1 when others end architecture To get proper looking output you need to set OPTIMIZE OUTPUT VHDL to YES in the config file This will also affect a number of other settings When they were not already set correctly doxygen will produce a warning telling which settings where overruled 3 1 4 Comment blocks in Fortran When using doxygen for Fortran code you should set OPTIMIZE_FOR_FORTRAN to YES For Fortran gt or lt starts a comment and or gt can be used to continuate a one line comment into a multi line comment Here is an example of a documented Fortran subroutine gt Build the restriction matrix for the aggregation method param aggr information about the aggregates todo Handle special case subroutine IntRestBuild A aggr Restrict A_ghost implicit none Type SpMtx intent in A lt our fine level matrix Type Aggrs intent in aggr Type SpMtx intent out Restrict lt Our restriction matrix As a alternative you can also use comments in fixed format code C gt Function comment C gt another line of comment function A i C gt input parameter integer i end func
228. one brief or detailed description is allowed but not recommended as the order in which the descriptions will appear is not specified As the name suggest a brief description is a short one liner whereas the detailed description provides longer more detailed documentation An in body description can also act as a detailed description or can describe a collection of implementation details For the HTML output brief descriptions are also used to provide tooltips at places where an item is referenced There are several ways to mark a comment block as a detailed description 1 You can use the JavaDoc style which consist of a C style comment block starting with two s like this kk X re DORU cas 2 or you can use the Qt style and add an exclamation mark after the opening of a C style comment block as shown in this example 20 Documenting the code x re EERE css In both cases the intermediate s are optional so x a text x is also valid Athird alternative is to use a block of at least two C comment lines where each line starts with an additional slash or an exclamation mark Here are examples of the two cases 117 saa text or Llica CORE nas ft Note that a blank line ends a documentation block in this case Some people like to make their comment blocks more visible in the documentation For this purpose you can use the following KI RR IRR I
229. one independent of where this documentation is located Generated by Doxygen Chapter 18 Doxygen usage Doxygen is a command line based utility Calling doxygen with the help option at the command line will give you a brief description of the usage of the program All options consist of a leading character followed by one character and one or more arguments depending on the option To generate a manual for your project you typically need to follow these steps 1 You document your source code with special documentation blocks see section Special comment blocks 2 You generate a configuration file see section Configuration by calling doxygen with the g option doxygen g lt config_file gt 3 You edit the configuration file so it matches your project In the configuration file you can specify the input files and a lot of optional information 4 You let doxygen generate the documentation based on the settings in the configuration file doxygen lt config_file gt If you have a configuration file generated with an older version of doxygen you can upgrade it to the current version by running doxygen with the u option doxygen u lt config_file gt All configuration settings in the original configuration file will be copied to the new configuration file Any new options will have their default value Note that comments that you may have added in the original configuration file will be lost 18 1 Fine tuning the
230. onverted it into an empty file with gt 256K of newlines Another case where this might happen is if you have lines in your code with more than 256K characters If you have run into such a case and want me to fix it you should send me a code fragment that triggers the message To work around the problem put some line breaks into your file split it up into smaller parts or exclude it from the input using EXCLUDE When running make in the latex dir get TeX capacity exceeded Now what You can edit the texmf cfg file to increase the default values of the various buffers and then run texconfig init Why are dependencies via STL classes not shown in the dot graphs Doxygen is unaware of the STL classes unless the option BUILTIN_STL_SUPPORT is turned on have problems getting the search engine to work with PHP5 and or windows Please read this for hints on where to look Can configure doxygen from the command line Not via command line options but doxygen can read from stdin so you can pipe things through it Here s an example how to override an option in a configuration file from the command line assuming a UNIX environment cat Doxyfile echo PROJECT_NUMBER 1 0 doxygen Generated by Doxygen 80 Frequently Asked Questions For Windows the following would do the same type Doxyfile echo PROJECT_NUMBER 1 0 doxygen exe If multiple options with the same name are specified then doxygen will use the
231. oo class create Class e o0 define OO Class definition method Class method definitions constructor Class constructor destructor Class destructor e public Set protection level protected Set protection level private Setprotection level Following is a example using doxygen style comments file tclexample tcl File documentation verbatim Startup code exec tclsh 0 se endverbatim Documented namespace c ns 9 The code is inserted here AANA PWN EH 10 code 11 namespace eval ns 12 Documented proc c ns_proc 13 param in arg some argument 14 proc ns_proc arg 15 Documented var c ns_var 16 Some documentation 17 variable ns_var Generated by Doxygen 30 Documenting the code 18 19 20 21 22 23 24 25 26 2d 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 45 76 77 78 79 80 Documented itcl class c itcl_class itcl class itel_class Create object constructor args eval Sargs Destroy object destructor exit Documented itcl method c itcl_method_x param in arg Argument private method itcl_method_x arg Documented itcl method c itcl_method_y param in arg Argument protected method itcl_method_y arg Documented itcl method c itcl_method_z param in arg Ar
232. ory tag file for ext2 doxygen configuration doxygen configuration doxygen configuration for proj for ext1 for ext2 file for proj file for ext1 file for ext2 Then the relevant parts of the configuration files look as follows proj cfg OUTPUT_DIRECTORY INPUT TAGFILES ext1 cfg OUTPUT_DIRECTORY GENERATE_TAGFILE ext2 cfg OUTPUT_DIRECTORY GENERATE_TAGFILE proj proj sre extl extl tag extl html ext2 ext2 tag ext2 html ext1 ext1 ext1 tag ext2 ext2 ext2 tag Generated by Doxygen Chapter 15 Frequently Asked Questions 1 How to get information on the index page in HTML You should use the mainpage command inside a comment block like this mainpage My Personal Index Page section intro_sec Introduction This is the introduction section install_sec Installation subsection stepl Step 1 Opening the box riek m ACA A A F F F A CACA 2 Help some all of the members of my class file namespace are not documented Check the following a Is your class file namespace documented If not it will not be extracted from the sources unless EXTRACT_ALL is set to YES in the config file b Are the members private If so you must set EXTRACT_PRIVATE to YES to make them appear in the documentation c Is there a function macro in your class that does not end with a semicolon e g MY_MACRO If so then you have to instr
233. ough the global functions Config_getXXX where XXX is the type of the option The argument of these function is a string naming the option as it appears in the configuration file For instance Config_getBool GENERATE_TESTLIST returns a reference to a boolean value that is TRUE if the test list was enabled in the config file The function readConfiguration insrc doxygen cpp reads the command line options and then calls the configuration parser C Preprocessor The input files mentioned in the config file are by default fed to the C Preprocessor after being piped through a user defined filter if available The way the preprocessor works differs somewhat from a standard C Preprocessor By default it does not do macro expansion although it can be configured to expand all macros Typical usage is to only expand a user specified set of macros This is to allow macro names to appear in the type of function parameters for instance Another difference is that the preprocessor parses but not actually includes code when it encounters a include with the exception of include found inside blocks The reasons behind this deviation from the standard is to prevent feeding multiple definitions of the same functions classes to doxygen s parser If all source files would include a common header file for instance the class and type definitions and their documentation would be present in each translation unit The preprocessor is writ
234. oxygen The XML output format is more standard but the Perl Module output format is possibly simpler and easier to use The Perl Module output format is still experimental at the moment and could be changed in incompatible ways in future versions although this should not be very probable It is also lacking some features of other Doxygen backends However it can be already used to generate useful output as shown by the Perl Module based LaTeX generator Please report any bugs or problems you find in the Perl Module backend or the Perl Module based LaTeX generator to the doxygen develop mailing list Suggestions are welcome as well 25 1 Usage When the GENERATE_PERLMOD tag is enabled in the Doxyfile running Doxygen generates a number of files in the perlmod subdirectory of your output directory These files are the following DoxyDocs pm This is the Perl module that actually contains the documentation in the Perl Module format described below DoxyModel pm This Perl module describes the structure of DoxyDocs pm independently of the actual documentation See below for details e doxyrules make This file contains the make rules to build and clean the files that are generated from the Doxyfile Also contains the paths to those files and other relevant information This file is intended to be included by your own Makefile e Makefile This is a simple Makefile including doxyrules make To make use of the documentation stored in Dox
235. par Side Effects n will allow you to put the command sideeffect or sideeffect in the documentation which will result in a user defined paragraph with heading Side Effects Note that you can put n s in the value part of an alias to insert newlines Also note that you can redefine existing special commands if you wish Some commands such as xrefitem are designed to be used in combination with aliases 13 2 Aliases with arguments Aliases can also have one or more arguments In the alias definition you then need to specify the number of arguments between curly braces In the value part of the definition you can place x markers where x represents the argument number starting with 1 Here is an example of an alias definition with a single argument ALIASES 1 1 ref M1 Inside a comment block you can use it as follows x x See l SomeClass for more information which would be the same as writing x x See ref SomeClass for more information 74 Custom Commands Note that you can overload an alias by a version with multiple arguments for instance ALIASES 1 1 ref 11 ALIASES 1 2 ref M1 2 Note that the quotes inside the alias definition have to be escaped with a backslash With these alias definitions we can write x x See l SomeClass Some Text for more information x inside the comment block and it will expand to x x See ref SomeClass Some Text for more information x
236. projectname will be replaced with the name of the project see PROJECT_NAME projectnumber will be replaced with the project number see PROJECT_NUMBER projectbrief will be replaced with the project brief description see PROJECT_BRIEF projectlogo will be replaced with the project logo see PROJECT_LOGO treeview will be replaced with links to the javascript and style sheets needed for the navigation tree or an empty string when GENERATE_TREEVIEW is disabled search will be replaced with a links to the javascript and style sheets needed for the search engine or an empty string when SEARCHENGINE is disabled mathjax will be replaced with a links to the javascript and style sheets needed for the MathJax feature or an empty string when USE_MATHJAX is disabled relpath If CREATE_SUBDIRS is enabled the command relpath can be used to produce a relative path to the root of the HTML output directory e g use relpath doxygen css to refer to the standard style sheet Generated by Doxygen 20 8 HTML related options 103 To cope with differences in the layout of the header and footer that depend on configuration settings the header can also contain special blocks that will be copied to the output or skipped depending on the configu ration Such blocks have the following form lt BEGIN BLOCKNAME gt Some context copied when condition BLOCKNAME holds lt END BLOCKNAME gt lt BEGIN BLOCKNAME
237. r and e it is preceded by a space newline or one the following characters lt An emphasis ends if e it is not following by an alphanumerical character and e it is not preceded by a space newline or one the following characters lt Lastly the span of the emphasis is limited to a single paragraph 4 3 5 Code Spans Limits Note that unlike standard Markdown doxygen leaves the following untouched A cool word in a nice sentence In other words a single quote cancels the special treatment of a code span wrapped in a pair of backtick characters This extra restriction was added for backward compatibility reasons 4 3 6 Lists Extensions With Markdown two lists separated by an empty line are joined together into a single list which can be rather unexpected and many people consider it to be a bug Doxygen however will make two separate lists as you would expect Example Iteml of list 1 Item2 of list 1 1 Iteml of list 2 2 Item2 of list 2 Historically doxygen has an additional way to create numbered lists by using markers iteml item2 4 3 7 Use of asterisks Special care has to be taken when using s in a comment block to start a list or make a ruler Doxygen will strip off any leading s from the comment before doing Markdown processing So although the following works fine x A list x x iteml x x item2 When you remove the leading s doxyge
238. rated by Doxygen 18 Getting Started Generated by Doxygen Chapter 3 Documenting the code This chapter covers two topics 1 How to put comments in your code such that doxygen incorporates them in the documentation it generates This is further detailed in the next section 2 Ways to structure the contents of a comment block such that the output looks good as explained in section Anatomy of a comment block 3 1 Special comment blocks A special comment block is a C or C style comment block with some additional markings so doxygen knows it is a piece of structured text that needs to end up in the generated documentation The next section presents the various styles supported by doxygen For Python VHDL Fortran and Tcl code there are different commenting conventions which can be found in sec tions Comment blocks in Python Comment blocks in VHDL Comment blocks in Fortran and Comment blocks in Tcl respectively 3 1 1 Comment blocks for C like languages C C C Objective C PHP Java For each entity in the code there are two or in some cases three types of descriptions which together form the documentation for that entity a brief description and detailed description both are optional For methods and functions there is also a third type of description the so called in body description which consists of the concatenation of all comment blocks found within the body of the method or function Having more than
239. ration file ES in the configuration file Note that the RTF output probably only looks nice with Microsoft s Word If you have success with other programs please let me know XML Generated if GENERAT E XML is set to Y ES in the configuration file The following output formats are indirectly supported by doxygen Compiled HTML Help a k a Windows 98 help Generated by Microsoft s HTML Help workshop from the HTML output if GENERATE_HTMLH ELP is setto YES Qt Compressed Help qch Generated by Qt s qhelpgenerator tool from the HTML output if GE set to YES Eclipse Help Generated from HTML with a special index file that is generated when GEN is set to YES XCode DocSets Compiled from HTML with a special index file that is generated when GE set to YES E_OHPis _ ECLIPSEHELP E_DOCSET is PostScript Generated from the IATEX output by running make ps in the output directory For the best results PDF_HYPERLINKS should be set to NO PDF Generated from the IATEX output by running make pdf in the output directory To improve the PDF out put you typically would want to enable the use of pdflatex by setting USE _PDFLATEX to YES in the configuration file In order to get hyperlinks in the PDF file you also need to enable PDF_HYPERLINKS 64 Output Formats Generated by Doxygen Chapter 11
240. ress the enum values from appearing in the overview section GENERATE_TREEVIEW The GENERATE_TREEVIEW tag is used to specify whether a tree like index structure should be generated to display hierarchical information If the tag value is set to YES a side panel will be generated containing a tree like index structure just like the one that is generated for HTML Help For this to work a browser that supports JavaScript DHTML CSS and frames is required i e any modern browser Windows users are probably better off using the HTML help feature Via custom stylesheets see HTML_STYLESHEET one can further fine tune the look of the index As an example the default style sheet generated by doxygen has an example that shows how to put an image at the root of the tree instead of the project name USE_INLINE_TREES By enabling USE_INLINE_TREES doxygen will generate the Groups Directories and Class Hierarchy pages using a tree view instead of an ordered list TREEVIEW_WIDTH If the treeview is enabled see GENERATE_TREEVIEW then this tag can be used to set the initial width in pixels of the frame in which the tree is shown EXT_LINKS_IN_WINDOW When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to external symbols imported via tag files in a separate window FORMULA_FONTSIZE Use this tag to change the font size of Latex formulas included as images in the HTML documentation The default is 10 when
241. riority help in answering questions To get a better understanding of the feasibility please let me know if you have a need for this type or another type of doxygen related commercial support Generated by Doxygen CONTENTS 3 Future work Although doxygen is successfully used by large number of companies and open source projects already there is always room for improvement You can submit enhancement requests in the bug tracker Make sure the severity of the bug report is set to enhancement Acknowledgements Thanks go to e Malte Z ckler and Roland Wunderling authors of DOC The first version of doxygen borrowed some code of an old version of DOC Although have rewritten practically all code since then DOC has still given me a good start in writing doxygen All people at Qt Software for creating a beautiful GUI Toolkit which is very useful as a Windows Unix platform abstraction layer My brother Frank for rendering the logos Harm van der Heijden for adding HTML help support e Wouter Slegers of Your Creative Solutions for registering the www doxygen org domain Parker Waechter for adding the RTF output generator e Joerg Baumann for adding conditional documentation blocks PDF links and the configuration generator Tim Mensch for adding the todo command Christian Hammond for redesigning the web site Ken Wong for providing the HTML tree view code Talin for adding support for
242. rresponds to a documented class is replaced by a link you should put a in front of the word To link to an all lower case symbol use ref 9 3 Links to files All words that contain a dot 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 9 4 Links to functions Links to functions are created if one of the following patterns is encountered 1 lt functionName gt lt argument list gt 2 lt functionName gt 60 Automatic link generation 3 lt functionName gt 4 lt className gt lt functionName gt lt argument list gt 5 lt className gt lt functionName gt lt argument list gt lt modifiers gt 6 lt className gt lt functionName gt 7 lt className gt lt functionName gt where n gt 0 Note 1 Function arguments should be specified with correct types i e fun const std string amp bool or to match any prototype Note 2 Member function modifiers like const and volatile are required to identify the target i e func int const and fun int target different member functions Note 3 For JavaDoc compatibility a may be used instead of a in the patterns above Note 4 In the documentation of a class containing a member foo a reference to a global variable is
243. rs 20 8 HTML related options GENERATE_HTML If the GENERATE_HTML tag is set to YES the default doxygen will generate HTML output HTML _ OUTPUT The HTML_OUTPUT tag is used to specify where the HTML docs will be put If a relative path is entered the value of OUTPUT_DIRECTORY will be put in front of it If left blank html will be used as the default path HTML FILE_EXTENSION The HTML_FILE_EXTENSION tag can be used to specify the file extension for each generated HTML page for example htm php asp If it is left blank doxygen will generate files with html extension HTML HEADER The HTML_HEADER tag can be used to specify a user defined HTML header file for each gen erated HTML page If the tag is left blank doxygen will generate a standard header To get valid HTML the header file that includes any scripts and style sheets that doxygen needs it is highly recommended to start with a default header using doxygen w html new_header html new_footer html new_stylesheet css YourConfigFile and then modify the file new_header html The following markers have a special meaning inside the header and footer title will be replaced with the title of the page datetime will be replaced with current the date and time date will be replaced with the current date year will be replaces with the current year doxygenversion will be replaced with the version of doxygen
244. rsonal LaTeX footer for the generated latex document The footer should contain everything after the last chapter If it is left blank doxygen will generate a standard footer Notice only use this tag if you know what you are doing PDF_HYPERLINKS lf the PDF_HYPERLINKS tag is set to YES the IAT X that is generated is prepared for conversion to PDF using ps2paf or pdflatex The PDF file will contain links just like the HTML output instead of page references This makes the output suitable for online browsing using a PDF viewer USE_PDFLATEX Ifthe LATEX_PDFLATEX tag is set to YES doxygen will use pdflatex to generate the PDF file directly from the IAT X files LATEX_BATCHMODE Ifthe LATEX_BATCHMODE tag is set to YES doxygen will add the batchmode command to the generated IATEX files This will instruct ATEX to keep running if errors occur instead of asking the user for help This option is also used when generating formulas in HTML Generated by Doxygen 108 Configuration LATEX_BIB STYLE The LATEX_BIB_STYLE tag can be used to specify the style to use for the bibliography e g plainnat orieeetr The default style is plain Seehttp en wikipedia org wiki BibTeX and cite for more info LATEX_HIDE_INDICES lf LATEX_HIDE_INDICES is set to YES then doxygen will not include the index chapters such as File Index Compound Index etc in the output LATEX_SOURCE_CODE If L
245. rtinet contact at e concept applications dot fr up to date Xavier Outhier xouthier at yahoo dot fr German Peter Grotrian Peter dot Grotrian at pdv FS dot de up to date Jens Seidel jensseidel at users dot sf dot net Greek Paul Gessos gessos dot paul at yahoo dot gr up to date Hungarian Akos Kiss akiss at users dot sourceforge dot net 1 4 6 F ldv ri Gy rgy unreachable foldvari lost at cyberspace Indonesian Hendy Irawan ceefour at gauldong dot net up to date Italian Alessandro Falappa alessandro at falappa dot net 1 7 5 Ahmed Aldo Faisal aaf23 at cam dot ac dot uk Japanese Hiroki Iseri goyoki at gmail dot com 1 6 0 Ryunosuke Satoh sun594 at hotmail dot com Kenji Nagamatsu naga at joyful dot club dot ne dot jp 174 Internationalization Iwasa Kazmi unreachable iwasa at cosmo system dot jp JapaneseEn see the Japanese language English based Korean Kim Taedong fly1004 at gmail dot com 1 7 5 SooYoung Jung jung5000 at gmail dot com Richard Kim unreachable ryk at dspwiz dot com KoreanEn see the Korean language English based Lithuanian Tomas Simonaitis unreachable haden at homelan dot lt 1 4 6 Mindaugas Radzius unreachable mindaugasradzius at takas dot lt Aidas Berukstis unreachable aidasber at takas dot 1t searching for the maintainer Please try to help to find someone Macedonian Slave Jovanovski slavejovanovski at yahoo dot com 1 6 0 Norwegian Lars Erik Jord
246. running text How do prevent that at a certain place Put a in front of the class name Like this MyClass Doxygen will then remove the and keep the word unlinked My favorite programming language is X Can I still use doxygen No not as such doxygen needs to understand the structure of what it reads If you don t mind spending some time on it there are several options If the grammar of X is close to C or C then it is probably not too hard to tweak src scanner a bit so the language is supported This is done for all other languages directly supported by doxygen i e Java IDL C PHP If the grammar of X is somewhat different than you can write an input filter that translates X into something similar enough to C C for doxygen to understand this approach is taken for VB Object Pascal and Javascript see http www stack nl dimitri doxygen download html helpers If the grammar is completely different one could write a parser for X and write a backend that produces a similar syntax tree as is done by src scanner and also by src tagreader cpp while reading tag files Help get the cryptic message input buffer overflow can t enlarge buffer because scanner uses REJECT This error happens when doxygen s lexical scanner has a rule that matches more than 256K of input char acters in one go I ve seen this happening on a very large generated file gt 256K lines where the built in preprocessor c
247. s o e csore corpete aredd wi 31 2 Comment Blocks iN PINON soc sica cr we ee da 3 1 3 Commentblocksin VADE o e ce a medot d pi wth ee e a 3 14 Comment blocks in Fortan 20 lt i ose se mecs rra e AA e ee 3 15 Comment blocksin Tel e se riina i ae e Pe a ae a a e oe ee a Anatomy of a comment DOCK i cado PR a a a E a a aes o 0 N N 11 11 12 13 14 14 15 16 16 16 16 16 17 CONTENTS 4 1 9 1 Inline Links oo ke a aso 4 1 9 2 Reference Links 4 4 Markdown 4 1 Standard Markdown o o e e e AAA PatagaphS ooo a a atte h AE gt Headers 0 ci LoS Rd EES 4 1 3 Block quotes 266 ee bee ee ee ee ee SAA RN 4 1 5 Code Blocks gp Re ee 4 1 6 Horizontal Rulers lt o cee ee ee ee ALT EMPHASIS sc ea ee A ma Bae Seed 4 1 8 COod Spans s cobi ics Lopaca e e aoa i i O48 CNES s e ece r a ee a ew ee MITO Mages oca ane ee ee a ee ee be ee 4 1 11 Automatic Linking 204 4 2 Markdown Extensions oc so cesan o 02 ee ad 4 2 1 Table of Contents o e ELE TABES oa aes RRA a 4 23 Fenced Code Blocks o e 4 2 4 Header ld Attributes lt 4 3 DOxVOSHSDECICS soc RR eee 4 3 1 Including Markdown files as pages 4 3 2 Treatment of HTML blocks 4 3 3 Code Block Indentation 434 Emphasis limits lt c so c sacs casona code 4 3 5 Code Spans Limits 4 5
248. s absolute i e counting from the start of the line Since doxygen comments can appear at any indentation level that is required by the programming language it uses a relative indentation instead The amount of indentation is counted relative to the preceding paragraph In case there is no preceding paragraph i e you want to start with a code block the minimal amount of indentation of the whole comment block is used as a reference In most cases this difference does not result in different output Only if you play with the indentation of paragraphs the difference is noticeable text text text code In this case Markdown will put the word code in a code block whereas Doxygen will treat it as normal text since although the absolute indentation is 4 the indentation with respect to the previous paragraph is only 1 Note that list markers are not counted when determining the relative indent 1 Iteml More text for iteml 2 Item2 Code block for item2 For Item1 the indentation is 4 when treating the list marker as whitespace so the next paragraph More text starts at the same indentation level and is therefore not seen as a code block Generated by Doxygen 40 Markdown 4 3 4 Emphasis limits Unlike standard Markdown doxygen will not touch internal underscores or stars so the following will appear as is a_nice_identifier Futhermore a x or _ only starts an emphasis if e it is followed by an alphanumberical characte
249. s in this description When a parameter is both input and output in out is used as attribute Here is an example for the function memcpy Generated by Doxygen 21 69 tparam lt template parameter name gt description 135 Copies bytes from a source memory area to a destination memory area where both areas may not overlap param out dest The memory area to copy to param in src The memory area to copy from param in n The number of bytes to copy void memcpy void dest const void src size_t n The parameter description is a paragraph with no special internal structure All visual enhancement commands may be used inside the paragraph Multiple adjacent param commands will be joined into a single paragraph Each parameter description will start on a new line The param description ends when a blank line or some other sectioning command is encountered See section fn for an example Note that you can also document multiple parameters with a single param command using a comma separated list Here is an example xx Sets the position param x y z Coordinates of the position in 3D space void setPosition double x double y double z double t Note that for PHP one can also specify the type or types if you separate them with a pipe symbol which are allowed for a parameter as this is not part of the definition The syntax is the same as for phpDocumentor i e param datatypel datatype2
250. script for CVS bin sh cvs status 1 sed n s Working revision t 0 9 0 9 1 p Example shell script for Subversion bin sh svn stat v 1 sed n s A Z 1 15 r s 1 15 r s p Example filter for ClearCase FILE_VERSION_INFO cleartool desc fmt Vn LAYOUT_FILE The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by doxygen The layout file controls the global structure of the generated output files in an output format independent way The create the layout file that represents doxygen s defaults run doxygen with the I option You can optionally specify a file name after the option if omitted DoxygenLayout xml will be used as the name of the layout file Note that if you run doxygen from a directory containing a file called DoxygenLayout xml doxygen will parse it automatically even if the LAYOUT_FILE tag is left empty CITE_BIB FILES The CITE_BIB_FILES tag can be used to specify one or more bib files containing the reference definitions This must be a list of bib files The bib extension is automatically appended if omitted This requires the bibtex tool to be installed See also http en wikipedia org wiki BibTex for more info For LaTeX the style of the bibliography can be controlled using LATEX_BIB_STYLE See also cite for info how to create references 20 4 Options related to warning and progress messages QUIET Th
251. se and a number of the examples given are of poor quality Here is the list of tags supported by doxygen e lt c gt Identifies inline text that should be rendered as a piece of code Similar to using lt tt gt text lt tt gt lt code gt Set one or more lines of source code or program output Note that this command behaves like code endcode for C code but it behaves like the HTML equivalent lt code gt lt code gt for other languages e lt description gt Part of a lt 1list gt command describes an item lt example gt Marks a block of text as an example ignored by doxygen e lt exception cref member gt Identifies the exception a method can throw e lt include gt Can be used to import a piece of XML from an external file Ignored by doxygen at the moment e lt item gt List item Can only be used inside a lt list gt context e lt list type typ S e gt Starts a list supported types are bullet or number and table A list con sts of a number of lt item gt tags A list of type table is a two column table which can have a header e lt listheader gt Starts the header of a list of type table e lt para gt ldentifies a paragraph of text lt param name pa ramName gt Marks a piece of text as the documentation for parameter param Name Similar to using param e lt paramref name paramName gt Refers to a parameter with name paramName Similar to using a e
252. st the following environment variables via Control Panel System Advanced Environment Variables e add c tools unxutils usr local wbin to the start of PATH e set BISON_SIMPLE to c tools unxutils usr local share bison simple Download doxygen s source tarball and put it somewhere e g use c tools Now start a new command shell and type cd c tools gunzip doxygen x y z srce tar gz tar xvf doxygen x y z src tar to unpack the sources Now your environment is setup to build doxygen Inside the doxygen x y z directory you will find a winbui ld directory containing a Doxygen s1n file Open this file in Visual Studio You can now build the Release or Debug flavor of Doxygen by right clicking the project in the solutions explorer and selecting Build Note that compiling Doxywizard currently requires Qt version 4 see http qt nokia com products platform qt fo1 Also read the next section for additional tools you may need to install to run doxygen with certain features enabled 1 5 Installing the binaries on Windows Doxygen comes as a self installing archive so installation is extremely simple Just follow the dialogs After installation it is recommended to also download and install GraphViz version 2 20 or better is highly recom mended Doxygen can use the dot tool of the GraphViz package to render nicer diagrams see the HAVE_DOT option in the configuration file If you want to produce compressed HTML files see GENERATE_
253. tag can be used to specify filters on a per file pattern basis Doxygen will compare the file name with each pattern and apply the filter if there is a match The filters are a list of the form pattern filter like cop my_cpp_filter See INPUT_FILTER for further info on how filters are used If FILTER_PATTERNS is empty or if none of the patterns match the file name INPUT_FILTER is applied FILTER_SOURCE_FILES lf the FILTER_SOURCE_FILES tag is set to YES the input filter if set using INP UT_FILTER will also be used to filter the input files that are used for producing the source files to browse i e when SOURCE_BROWSER is set to YES FILTER_SOURCE_PATTERNS The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file pattern A pattern will override the setting for FILTER_PATTERN if any and it is also possible to disable source filtering for a specific pattern using ext so without naming a filter This option only has effect when FILTER_SOURCE_FILES is enabled 20 6 Source browsing related options SOURCE_BROWSER If the SOURCE_BROWSER tag is set to YES then a list of source files will be generated Documented entities will be cross referenced with these sources Note To get rid of all source code in the generated output make sure also VERBAT IM_HEADERS is set to NO T INLINE_SOURCES Setting the INLINE_SOURCES tag to
254. tails 132 dir 119 dontinclude 141 dot 147 dottile 148 e 148 else 132 elseif 132 em 149 endcode 149 endcond 132 enddot 149 endhtmlonly 149 endif 132 endinternal 120 endlatexonly 149 endlink 139 endmanonly 149 endmsc 149 endrtfonly 150 endverbatim 150 endxmlonly 150 enum 119 example 119 exception 132 extends 120 f 150 f 150 f 150 file 120 fn 121 headerfile 121 hideinitializer 122 htmlinclude 144 htmlonly 151 if 133 ifnot 133 image 151 implements 122 include 142 includelineno 142 ingroup 122 interface 123 internal 123 invariant 134 latexonly 152 li 152 line 143 link 139 mainpage 123 manonly 152 memberof 123 msc 147 mscfile 148 n 153 name 124 namespace 124 nosubgrouping 124 note 134 overload 124 p 153 package 125 page 125 180 INDEX par 134 paragraph 141 param 134 post 135 pre 135 private 126 privatesection 126 property 126 protected 126 protectedsection 126 protocol 127 public 127 publicsection 127 ref 139 relates 127 relatesalso 128 remark 136 remarks 136 result 136 return 136 returns 136 retval 136 rtfonly 153 sa 136 section 140 see 137 short 137 showinitializer 128 since 137 skip 143 skipline 143 snippet 143 struct 128 subpage 139 subsection 140 subsubsec
255. tation block before a file Of course file members functions variables typedefs defines do not need an explicit structural command just putting a special documentation block in front or behind them will work fine The text inside a special documentation block is parsed before it is written to the HTML and or TEX output files During parsing the following steps take place Markdown formatting is replaced by corresponding HTML or special commands e The special commands inside the documentation are executed See section Special Commands for an overview of all commands If a line starts with some whitespace followed by one or more asterisks x and then optionally more whites pace then all whitespace and asterisks are removed All resulting blank lines are treated as a paragraph separators This saves you from placing new paragraph commands yourself in order to make the generated documentation readable Links are created for words corresponding to documented classes unless the word is preceded by a then the word will not be linked and the sign is removed e Links to members are created when certain patterns are found in the text See section Automatic link gener ation for more information on how the automatic link generation works e HTML tags that are in the documentation are interpreted and converted to IATEX equivalents for the IATEX output See section HTML Commands for an overview of all supported HTML tags Gene
256. tected private and public 21 38 relates lt name gt This command can be used in the documentation of a non member function lt name gt It puts the function inside the related function section of the class documentation This command is useful for documenting non friend functions that are nevertheless strongly coupled to a certain class It prevents the need of having to document a file but only works for functions Example x A String class class String friend int strcmp const String amp const String y Ir Compares two strings Generated by Doxygen 128 Special Commands int strcmp const String csl const String amp s2 x relates String A string debug function void stringDebug 21 39 related lt name gt Equivalent to relates 21 40 relatesalso lt name gt This command can be used in the documentation of a non member function lt name gt It puts the function both inside the related function section of the class documentation as well as leaving it at its normal file documentation location This command is useful for documenting non friend functions that are nevertheless strongly coupled to a certain class It only works for functions 21 41 relatedalso lt name gt Equivalent to relatesalso 21 42 showinitializer By default the value of a define and the initializer of a variable are only displayed if they are less than 30 lines
257. ten using flex and can be found in src pre 1 For condition blocks if evaluation of constant expressions is needed For this a yacc based parser is used which can be found in src constexp y and src constexp 1 The preprocessor is invoked for each file using the preprocessFile function declared in src pre h and will append the preprocessed result to a character buffer The format of the character buffer is 0x06 file name 1 0x06 preprocessed contents of file 1 0x06 file name n 0x06 preprocessed contents of file n Language parser The preprocessed input buffer is fed to the language parser which is implemented as a big state machine using flex It can be found in the file src scanner 1 There is one parser for all languages C C Java IDL The state variables insideIDL and insideJava are uses at some places for language specific choices The task of the parser is to convert the input buffer into a tree of entries basically an abstract syntax tree An entry is defined in src entry h and is a blob of loosely structured information The most important field is section which specifies the kind of information contained in the entry Possible improvements for future versions Use one scanner parser per language instead of one big scanner e Move the first pass parsing of documentation blocks to a separate module e Parse defines these are currently gathered by the preprocessor and ignored by the language parser Data organi
258. ter preprocessing has been done Hint set QUIET YES and WARNINGS NO in the configuration file to disable any other output Generated by Doxygen Chapter 9 Automatic link generation Most documentation systems have special see also sections where links to other pieces of documentation can be inserted 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 For lATEX documentation a reference to the page number is written instead of a link 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 man pages no reference information is generated The next sections show how to generate links to the various documented entities in a source file 9 1 Links to web pages and mail addresses Doxygen will automatically replace any URLs and mail addresses found in the documentation by links in HTML To manually specify link text use the HTML a tag lt a href linkURL gt link text lt a gt which will be automatically translated to other output formats by Doxygen 9 2 Links to classes All 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 If you want to prevent that a word that co
259. the DIRECTORY_GRAPH SHOW_DIRECTORIES and HAVE_DOT options are set to YES then doxygen will show the dependencies a directory has on other directories in a graphical way The dependency relations are determined by the include relations between the files in the directories DOT_GRAPH MAX NODES The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes that will be shown in the graph If the number of nodes in a graph becomes larger than this value doxygen will truncate the graph which is visualized by representing a node as a red box Note that doxygen if the number of direct children of the root node in a graph is already larger than DOT_GRAPH_MAX_NO DES then the graph will not be shown at all Also note that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH MAX _DOT_GRAPH DEPTH The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs generated by dot A depth value of 3 means that only nodes reachable from the root by following a path via at most 3 edges will be shown Nodes that lay further from the root node will be omitted Note that setting this option to 1 or 2 may greatly reduce the computation time needed for large code bases Also note that the size of a graph can be further restricted by DOT_GRAPH_MAX_NODES Using a depth of 0 means no depth restriction the default DOT_IMAGE_FORMAT The DOT_IMAGE_FORMAT tag can be used to set the image format of th
260. tion 141 tableofcontents 140 test 137 throw 137 throws 137 todo 137 tparam 135 typedef 128 union 129 until 144 var 129 verbatim 153 verbinclude 144 version 137 warning 138 xmlonly 154 xrefitem 138 154 ABBREVIATE_BRIEF 94 acknowledgements 3 ALIASES 95 ALLEXTERNALS 110 ALPHABETICAL_INDEX 102 ALWAYS_DETAILED_SEC 94 BINARY_TOC 105 bison 7 BRIEF_MEMBER_DESC 94 browser 16 BUILTIN _STL_SUPPORT 94 CALL_GRAPH 111 CALLER_GRAPH 112 CASE_SENSE_NAMES 97 CHM_FILE 104 CHM_INDEX_ENCODING 105 CITE_BIB_FILES 99 CLASS_ DIAGRAMS 110 CLASS_GRAPH 111 COLLABORATION_GRAPH 111 COLS_IN_ALPHA_INDEX 102 COMPACT_LATEX 107 COMPACT_RTF 108 CPP_CLI_SUPPORT 95 CREATE_SUBDIRS 93 DIRECTORY_GRAPH 112 DISABLE_INDEX 106 DISTRIBUTE_GROUP_DOC 95 Doc 3 DOCSET_FEEDNAME 104 DOT_CLEANUP 112 DOT_FONTNAME 111 DOT_FONTPATH 111 DOT_GRAPH_MAX_NODES 112 DOT_IMAGE_FORMAT 112 DOT_MULTI_TARGET 112 DOT_NUM_THREADS 111 DOT_PATH 112 DOT_TRANSPARENT 112 DOTFILE_DIRS 112 DOXYFILE_ENCODING 93 ECLIPSE_DOC_ID 105 ENABLE _PREPROCESSING 109 ENABLED_SECTIONS 98 ENUM_VALUES_PER_LINE 106 EXAMPLE_PATH 100 EXAMPLE_PATTERNS 100 EXAMPLE_RECURSIVE 100 EXCLUDE 100 EXCLUDE_ PATTERNS 100 EXCLUDE_SYMLINKS 100 EXPAND_AS_DEFINED 110 EXPAND_ONLY_PREDEF 109 EXT_LINKS_IN_WINDOW 106 EXTENSION_MAPPING 95 EXTERNAL_GROUPS 110 EXTRA_PACKAGES 107 EXTRACT_ALL 96 EXTRACT_
261. tion either global or as a member of a class This command is only needed if a comment block is not placed in front or behind the function declaration or definition If your comment block is in front of the function declaration or definition this command can and to avoid redundancy should be omitted A full function declaration including arguments should be specified after the fn command on a single line since the argument ends at the end of the line This command is equivalent to var typedef and property Warning Do not use this command if it is not absolutely needed since it will lead to duplication of information and thus to errors Example class Test public const char member char int throw std out_of_range Y const char Test member char c int n throw std out_of_range x class Test x brief Test class Details about Test x 1 fn const char xTest member char c int n brief A member function param c a character param n an integer exception std out_of_range parameter is out of range return a character pointer Ox Ox F OF See also sections var property and typedef 21 16 headerfile lt header file gt lt header name gt Intended to be used for class struct or union documentation where the documentation is in front of the definition The arguments of this command are the same as the second and third argument of class The lt header file gt
262. tion A Generated by Doxygen 3 1 Special comment blocks 29 3 1 5 Comment blocks in Tel Doxygen documentation can be included in normal Tcl comments To start a new documentation block start a line with two hashes All following comment lines and continuation lines will be added to this block The block ends with a line not starting with a hash sign A brief documentation can be added with lt semicolon hash and lower then sign The brief documentation also ends at a line not starting with a hash sign Inside doxygen comment blocks all normal doxygen markings are supported The only exceptions are described in the following two paragraphs If a doxygen comment block ends with a line containing only Hi code or 4 code all code until a line only containing endcode or endcode is added to the generated documentation as code block If a doxygen comment block ends with a line containing only verbatim or verbat im all code until a line only containing Hendverbat im or endverbat im is added verbatim to the generated documentation To detect namespaces classes functions and variables the following Tcl commands are recognized Documenta tion blocks can be put on the lines before the command namespace eval Namespace e proc Function variable Variable common Common variable e itcl class Class e itcl body Class method body definition e
263. tiple words lt tt gt 21 146 rtfonly Starts a block of text that will be verbatim included in the generated RTF documentation only The block ends with a endrtfonly command This command can be used to include RTF code that is too complex for doxygen Note environment variables like HOME are resolved inside a RTF only block See also section manonly section xmlonly section latexonly and section htmlonly 21 147 verbatim Starts a block of text that will be verbatim included in the documentation The block should end with a endverbatim block All commands are disabled in a verbatim block Generated by Doxygen 154 Special Commands Warning Make sure you include a endverbatim command for each verbatim command or the parser will get confused See also section code and section verbinclude 21 148 1 xmlonly Starts a block of text that will be verbatim included in the generated XML output only The block ends with a endxmlonly command This command can be used to include custom XML tags See also section manonly section rtfonly section latexonly and section htmlonly 21 149 AN This command writes a backslash character 1 to the output The backslash has to be escaped in some cases because doxygen uses it to detect commands 21 150 10 This command writes an at sign to the output The at sign has to be escaped in some cases because doxygen uses it to detect JavaDoc comm
264. u can make a doc set out of the HTML files pro duced by doxygen A doc set consists of a single directory with a special structure containing the HTML files along with a precompiled search index A doc set can be embedded in Xcode the integrated development environment provided by Apple To enable the creation of doc sets set GENERATE_DOCSET to YES in the config file There are a couple of other doc set related options you may want to set After doxygen has finished you will find a Makefile in the HTML output directory Running make install on this Makefile will compile and install the doc set See this article for more info Advantage of this method is that it nicely integrates with the Xcode development environment allowing for instance to click on an identifier in the editor and jump to the corresponding section in the doxygen documentation Disadvantage is that it only works in combination with Xcode on MacOSX 5 Qt Compressed Help If you develop for or want to install the Qt application framework you will get an application called Ot assistant This is a help viewer for Qt Compressed Help files qch To enable this feature set GENERATE_QHP to YES You also need to fill in the other Qt help related options such as QHP_NAMESPACE QHG_LOCATION QHP_VIRTUAL_FOLDER See this article for more info Feature wise the Qt compressed help feature is comparable with the CHM output with the additional advantage that compiling the QCH
265. uct doxygen s preprocessor to remove it This typically boils down to the following settings in the config file ENABLE_PREPROCESSING YES MACRO_EXPANSION YES EXPAND_ONLY_PREDEF YES PREDEFINED MY_MACRO Please read the preprocessing section of the manual for more information 3 When set EXTRACT_ALL to NO none of my functions are shown in the documentation In order for global functions variables enums typedefs and defines to be documented you should document the file in which these commands are located using a comment block containing a file or file command Alternatively you can put all members in a group or module using the ingroup command and then document the group using a comment block containing the defgroup command For member functions or functions that are part of a namespace you should document either the class or namespace 4 How can make doxygen ignore some code fragment The new and easiest way is to add one comment block with a cond command at the start and one comment block with a endcond command at the end of the piece of code that should be ignored This should be within the same file of course But you can also use Doxygen s preprocessor for this If you put 78 Frequently Asked Questions ifndef DOXYGEN_SHOULD_SKIP_THIS code that must be skipped by Doxygen x endif DOXYGEN_SHOULD_SKIP_THIS x around the blocks that should be hidden and put PREDEFINED DOXYGEN_SHOULD_SK
266. ume all classes use public instead of private inheritance when no explicit protection keyword is present IDL PROPERTY SUPPORT For Microsoft s IDL there are propget and propput attributes to indicate getter and setter methods for a property Setting this option to YES the default will make doxygen to replace the get and set methods by a property in the documentation This will only work if the methods are indeed getting or setting a simple type If this is not the case or you want to show the methods anyway you should set this option to NO DISTRIBUTE_GROUP_DOC If member grouping is used in the documentation and the DISTRIBUTE_GROUP _DOC tag is set to YES then doxygen will reuse the documentation of the first member in the group if any for the other members of the group By default all members of a group must be documented explicitly MULTILINE_CPP_IS_BRIEF The MULTILINE_CPP_IS_ BRIEF tag can be set to YES to make Doxygen treat a multi line C special comment block i e a block of or comments as a brief description This used to be the default behavior The new default is to treat a multi line C comment block as a detailed description Set this tag to YES if you prefer the old behavior instead Note that setting this tag to YES also means that rational rose comments are not recognized any more INHERIT_DOCS Ifthe INHERIT_DOCS tag is set to YES the default then an undocumented member inherits the documentation from any document
267. umentation and not in other documentation blocks and only has effect in the HTML output 21 97 section lt section name gt section title Creates a section with name lt section name gt The title of the section should be specified as the second argument of the section command Warning This command only works inside related page documentation and not in other documentation blocks See also Section page for an example of the section command 21 98 subsection lt subsection name gt subsection title Creates a subsection with name lt subsection name gt The title of the subsection should be specified as the second argument of the subsection command Generated by Doxygen 21 99 subsubsection lt subsubsection name gt subsubsection title 141 Warning This command only works inside a section of a related page documentation block and not in other documenta tion blocks See also Section page for an example of the subsection command 21 99 subsubsection lt subsubsection name gt subsubsection title Creates a subsubsection with name lt subsubsection name gt The title of the subsubsection should be specified as the second argument of the subsubsection command Warning This command only works inside a subsection of a related page documentation block and not in other docu mentation blocks See also Section page for an example of the section command and subsection command 21 100 paragraph
268. umeration values Test Vall and GVal2 x Since this documentation block belongs to the class Test no link to Test is generated Two ways to link to a constructor are Test and Test Links to the destructor are Test and Test A link to a member in this class member More specific links to the each of the overloaded members member int and member int int A link to the variable var A link to the global typedef B A link to the global enumeration type GlobEnum A link to the define ABS x A link to a variable link var using another textlendlink as a link A link to the enumeration type EType A link to some enumeration values link Test Vall Vall endlink and GVall And last but not least a link to a file autolink cpp sa Inside a see also section any word is checked so EType Vall GVall Test and member will be replaced by links in HTML class Test y public Test lt constructor Test lt destructor void member int x lt A member function Details void member int int lt An overloaded member function Details xx An enum type More details x enum EType Vall x x lt enum value 1 x Val2 x x lt enum value 2 x y protected int var x lt A member variable x details Test Test x details Test Test A global variable int globVar A global enum enum GlobEnum
269. unc pass Documentation for a class More details class PyClass The constructor def __ init__ self self _memVar 0 Documentation for a method def PyMethod self pass A class variable classVar 0 var _memVar a member variable Since python looks more like Java than like C or C you should set OPTIMIZE_OUTPUT_JAVA to Y config file 3 1 3 Comment blocks in VHDL For VHDL a comment normally start with param self The object pointer ES in the Doxygen will extract comments starting with There are only two types of comment blocks in VHDL a one line comment representing a brief description and a multi line comment where the prefix is repeated for each line representing a detailed description Comments are always located in front of the item that is being documented with one exception for ports the comment can also be after the item and is then treated as a brief description for the port Generated by Doxygen 28 Documenting the code Here is an example VHDL file with doxygen comments file brief 2 1 Mux using with select Use standard library library ieee Use logic elements use ieee std_logic_1164 all Mux entity brief description Detailed description of this mux design element entity mux_using_with is port din_0 in std_logic Mux first input din_1 in std_logic Mux Sec
270. urLanguage endif after the if Le it must be placed after the code for creating the English translator at the beginning and beforetheelse partthat creates the translator for the default language English again T ADERS line 5 Edit libdoxygen pro in and add translator_xx h tothe H 6 Edittranslator_xx h e Rename TRANSLATOR_EN_H to TRANSLATOR_XX_H twice i e in the ifndef and defin preprocessor commands at the beginning of the file Rename TranslatorEnglish to TranslatorYourLanguage In the member idLanguage change english into the name of your language use lower case characters only Depending on the language you may also wish to change the member functions latex LanguageSupportCommand idLanguageCharset and others you will recognize them when you start the work Edit all the strings that are returned by the member functions that start with tr Try to match punctuation and capitals To enter special characters with accents you can Enter them directly if your keyboard supports that and you are using a Latin 1 font Doxygen will translate the characters to proper IATEX and leave the HTML and man output for what it is which is fine if idLanguageCharset is set correctly Use html codes like amp auml for an a with an umlaut i e a See the HTML specification for the codes 7 Run configure and make again from the root of the distribut
271. uto linking to word that is also a documented class or struct 21 158 Y This command writes the character to the output This character has to be escaped in some cases because it is used in pairs to indicate an unformatted text fragment 21 159 This command writes a dot to the output This can be useful to prevent ending a brief description when JAVAD OC_AUTOBRIEF is enabled or to prevent starting a numbered list when the dot follows a number at the start of a line 21 160 1 This command write a double colon to the output This character sequence has to be escaped in some cases because it is used to ref to documented entities Commands included for Qt compatibility The following commands are supported to remain compatible to the Qt class browser generator Do not use these commands in your own documentation e annotatedclasslist e classhierarchy define functionindex Generated by Doxygen 156 Special Commands header headerfilelist e inherit AN e postheader Generated by Doxygen Chapter 22 HTML commands Here is a list of all HTML commands that may be used inside the documentation Note that although these HTML tags are translated to the proper commands for output formats other than HTML all attributes of a HTML tag are passed on to the HTML output only the HREF and NAME attributes for the A tag are the only exception e lt A HREF gt Starts a hyperlink i
272. v for the list of possible encodings PROJECT_NAME The PROJECT_NAME tag is a single word or a sequence of words surrounded by double quotes that should identify the project for w title of most generated pages and in a few ot hich the documentation is generated This name is used in the her places PROJECT_NUMBER The PROJECT_NUMBER tag can be used to enter a project or revision number This could be handy for archiving the generated documentation or if some version control system is used PROJECT_BRIEF Using the PROJECT_BRIEF tag one can provide an optional one line description for a project that appears at the top of each page and should give viewer a quick idea about the purpose of the project Keep the description short PROJECT_LOGO With the PROJECT_LOGO tag one can specify an logo or icon that is included in the docu mentation The maximum height of the logo should not exceed 55 pixels and the maximum width should not exceed 200 pixels Doxygen will copy the logo to the output directory OUTPUT_DIRECTORY The OUTPUT_DIRECTORY tag is used to specify the relative or absolute path into which the generated documentation will be written If a relative path is entered it will be relative to the location where doxygen was started If left blank the current directory will be used CREATE_SUBDIRS If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub directories in
273. was started with a internal command The text between internal and endinternal will only be visible if INTERNAL_DOCS is set to YES 21 13 extends lt name gt This command can be used to manually indicate an inheritance relation when the programming language does not support this concept natively e g C The file manual c in the example directory shows how to use this command See also section implements and section memberof 21 14 file lt name gt Indicates that a comment block contains documentation for a source or header file with name lt name gt The file name may include part of the path if the file name alone is not unique If the file name is omitted i e the line after file is left blank then the documentation block that contains the file command will belong to the file it is located in Important The documentation of global functions variables typedefs and enums will only be included in the output if the file they are in is documented as well Example x file file h A brief file description Generated by Doxygen 21 15 fn function declaration 121 A more elaborated file description xk A global integer value x More details about this value extern int globalValue Note In the above example JAVADOC_AUTOBRIEF has been set to YES in the configuration file 21 15 fn function declaration Indicates that a comment block contains documentation for a func
274. will mention the files that were used to generate the documentation SHOW_DIRECTORIES Ifthe sources in your project are distributed over multiple directories then setting the SH OW_DIRECTORIES tag to YES will show the directory hierarchy in the documentation SHOW_FILES Set the SHOW_FILES tag to NO to disable the generation of the Files page This will remove the Files entry from the Quick Index and from the Folder Tree View if specified The default is YES SHOW_NAMESPACES Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces page This will remove the Namespaces entry from the Quick Index and from the Folder Tree View if speci fied The default is YES T FILE VERSION_ FILTER The FILE_VERSION_FILTER tag can be used to specify a program or script that doxygen should invoke to get the current version for each file typically from the version control system Doxygen will invoke the program by executing via popen the command command input file where command is the value of the FILE_VERSION_FILTER tag and input file is the name of an input file provided by doxygen Whatever the program writes to standard output is used as the file version Example of using a shell script as a filter for Unix T FILE _VERSION_FILTER bin sh versionfilter sh Generated by Doxygen 20 4 Options related to warning and progress messages 99 Example shell
275. y are included e g using ingroup instead of on a separate page for HTML and Man pages or section for LaTeX and RTF Note that this feature does not work in combination with SEPARATE_MEMBER_PAGES TYPEDEF_HIDES_STRUCT When TYPEDEF_HIDES_STRUCT is enabled a typedef of a struct union or enum is documented as struct union or enum with the name of the typedef So typedef struct TypeS TypeT will appear in the documentation as a struct with name TypeT When disabled the typedef will appear as a member of a file namespace or class And the struct will be named Types This can typically be useful for C code in case the coding convention dictates that all compound types are typedef ed and only the typedef is referenced never the tag name SYMBOL_CACHE SIZE The SYMBOL_CACHE_SIZE determines the size of the internal cache use to deter mine which symbols to keep in memory and which to flush to disk When the cache is full less often used symbols will be written to disk For small to medium size projects lt 1000 input files the default value is probably good enough For larger projects a too small cache size can cause doxygen to be busy swapping symbols to and from disk most of the time causing a significant performance penalty If the system has enough physical memory increasing the cache will improve the performance by keeping more symbols in memory Note that the value works on a logarithmic scale so increasing the size by o
276. yDocs pm you can use one of the default Perl Module based generators provided by Doxygen at the moment this includes the Perl Module based LaTeX generator see below or write your own customized generator This should not be too hard if you have some knowledge of Perl and it s the main purpose of including the Perl Module backend in Doxygen See below for details on how to do this 25 2 Using the LaTeX generator The Perl Module based LaTeX generator is pretty experimental and incomplete at the moment but you could find it useful nevertheless It can generate documentation for functions typedefs and variables within files and classes 170 Perl Module Output format and can be customized quite a lot by redefining TeX macros However there is still no documentation on how to do this Setting the PERLMOD_LATEX tag to YES in the Doxyfile enables the creation of some additional files in the perlmod subdirectory of your output directory These files contain the Perl scripts and LaTeX code necessary to generate PDF and DVI output from the Perl Module output using PDFLaTeX and LaTeX respectively Rules to automate the use of these files are also added to doxyrules make and the Makefile The additional generated files are the following doxylatex pl This Perl script uses DoxyDocs pm and DoxyModel pm to generate doxydocs tex a TeX file containing the documentation in a format that can be accessed by LaTeX code This file is not directly LaTe
277. zer This step consists of many smaller steps that build dictionaries of the extracted classes files namespaces vari ables functions packages pages and groups Besides building dictionaries during this step relations such as inheritance relations between the extracted entities are computed Each step has a function defined in src doxygen cpp which operates on the tree of entries built during language parsing Look at the Gathering information part of parseInput for details Generated by Doxygen 167 The result of this step is a number of dictionaries which can be found in the Doxygen namespace defined in src doxygen h Most elements of these dictionaries are derived from the class Definition The class MemberDef for instance holds all information for a member An instance of such a class can be part of a file class FileDef a class class ClassDef a namespace class NamespaceDef a group class Group Def or a Java package class PackageDef Tag file parser If tag files are specified in the configuration file these are parsed by a SAX based XML parser which can be found in src tagreader cpp The result of parsing a tag file is the insertion of Ent ry objects in the entry tree The field Entry tagInfo is used to mark the entry as external and holds information about the tag file Documentation parser Special comment blocks are stored as strings in the entities that they document There

Manual for version 1.8.0 Written by Dimitri van Heesch ©1997-2012

Contents

Download Pdf Manuals

Related Search

Related Contents

Manual for version 1.8.0 Written by Dimitri van Heesch &copy;1997-2012

Contents

Download Pdf Manuals

Related Search

Related Contents

Manual for version 1.8.0 Written by Dimitri van Heesch ©1997-2012