Home

manual is provided

1. 22 18 DOCSET_FEEDNAME 6 5 00 000s 22 8 GROUP_GRAPHS 2055 22 18 DOCSET_PUBLISHER_ID 22 8 PAVE DOT aaa inma aed Backes a i 22 18 DOCSET_PUBLISHER_NAME 22 8 HG LOCATION 2 6 ca feta da ewe dod 22 8 DOTAILE DIRS kaka nea ava ee ene 22 18 HIDE_FRIEND_COMPOUNDS 22 3 DOT_GLEANUP o o ea aco ee 22 18 HIDE IN BODY DOCS o coa cada aeaea 22 3 DOT_FONTNAME o 22 18 HIDE_SCOPE_NAMES 22 3 DOT FONTPATH oia aao pa a Pw aad 22 18 HIDE_UNDOC_CLASSES 22 3 DOT FONTSIZE 2 6 acu preker tinenta 22 18 HIDE_LUNDOC_MEMBERS 22 3 DOT_GRAPH_MAX_NODES 22 18 HIDE_UNDOC_RELATIONS 22 18 DOT_IMAGE_FORMAT 22 18 HTML_COLORSTYLE_GAMMA 22 8 DOT_MULTILTARGETS 22 18 HTML_COLORSTYLE_HUE 22 8 DOT_NUM_THREADS 22 18 HTML_COLORSTYLE_SAT 22 8 DOT PATH cies eos gas a a 22 18 HTML_DYNAMIC_SECTIONS 22 8 DOT TRANSPARENT ccrte reata pidea 22 18 HTML EXTRA FILES oa oe cesa roere asit 22 8 DOXYFILE_ENCODING co so ek eee 22 2 HTML_EXTRA_STYLESHEET o oo 22 8 ECLIPSE DOG D or oiga baa Oe EY aad 22 8 HTML_FILE EXTENSION gt cce ae ee ewes 22 8 ENABLED SECTIONS icco co poe taa iia a 22 3 HTML FOOTER o 0c cc ca niota maak 22 8 ENABLE_PREPROCESSING 22 16 HTML HEADER
2. 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 fprojectname 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_NAMEB or the project number see PROJECT_NUMBER This tag requires that the tag GENERATE_LATEX is set to Y Gl S LATEX_FOOTER The LATEX_FOOTER tag can be used to specify a personal lAT X footer for the generated IATEX document The footer should contain everything after the last chapter If it is left blank doxygen will generate a standard footer Note Only use a user defined footer if you know what you are doing This tag requires that the tag GENERATE_LATEX is set to YES LATEX_EXTRA_FILES The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or other source files which should be copied to the LATEX_OUTPUT output directory Note that the files will be copied as is there are no commands or markers available This tag requires that the tag GENERATE_
3. 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 is used a substring Examples ANamespace AClass Ae Class 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 more files or directories that contain example code fragments that are included see the include commana Generated by Doxygen 22 6 Configuration options related to source browsing 113 EXAMPLE PATTERNS If the value of the EXAMPLE_PATH tag contains directories you can use the EXAMP Le 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 EXAMPLE RECURSIVE Ifthe 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 RECURSIVE tag The default value is NO 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
4. amp radic square root radical sign y amp prop proportional to e amp infin infinity co ang angle Z and logical and wedge A amp OX logical or vee V Cap intersection cap N amp cup union cup U e amp int integral f amp there4 therefore Generated by Doxygen 189 amp sim e amp cong e asymp amp ne e equiv le ge amp sub amp sup e nsub e amp sube amp supe e oplus otimes amp perp e amp sdot e amp lceil e amp rceil 1f oor amp r f loor e amp lang amp rang amp 10Z amp spades e amp clubs e amp hearts amp diams amp quot e amp e l1t amp gt 0El e amp O a 1g e lig amp Scaron e scaron e Yuml tilde operator varies with similar to approximately equal to S almost equal to asymptotic to not equal to 4 identical to less than or equal to lt greater than or equal to gt subset of C superset of gt not a subset of subset of or equal to C superset of or equal to gt circled plus direct sum circled times vector product amp up tack orthogonal to perpendicular L dot operator left ceiling apl upstile right ceiling left floor apl downstile
5. 2 005 e e 155 23 70 PADO h a Sedan ae Red ol Ga Bk aw OM bow a hee Ad ae 156 DE WNODEIDIONK e Hoe a ee a a ee ee ae ER Ree eee ee ee A 156 23 75 Mparam lt template parameter name gt description 2 2 20 0 156 23 716 post description of the posicondition s lt co aa ee ee ee 156 23 77 pre description of the precondition lt c c se esasa o rades ee 156 2379 WemarKi TOMAR TORE o os saa ee A RA ee ee A ee ee a 157 29 79 Temarks remark text ocre a A A ER Ree ee RG ee ea 157 23 80 result description of the result value 2 o o e 157 23 81 return description of the return value o e o 157 23 82 returns description of the return Value o 0002 ee 157 23 83 Weal lt return vale Gescription s ce asea A A A 157 ARE GAL PISCO cc ee a ee A A See EE Oe a a ae ae a ee E Y 157 Generated by Doxygen CONTENTS Vil 23 09 SOS ISTMO Gide a PED RD A OE ERE Ae Bs 158 23 00 GNOME SHON HOSONPRON se corae AR ee ee ee ee Re we a G 158 A o be a GB eee oe eS ae A ek Ge Go Sh Ba a ee ee ae bee eet I 158 23 88 Mest paragraph describing a test case ee 158 23 89 throw lt exception object gt exception description o o 158 23 90 throws lt exception object gt exception description o 158 23 91 ltodo paragraph describing w
6. EXPAND_AS DEFINED If the MACRO_EXPANSION and EXPAND _ONLY_PREDEF tags are set to YES 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 that overrules the definition found in the source code This tag requires that the tag ENABLE_PREPROCESSING is set to Y E S SKIP_FUNCTION_MACROS Ifthe SKIP_FUNCTION_MACROS tag is set to YES then doxygen s preprocessor will remove all references to 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 The default value is YES This tag requires that the tag ENABLE_PREPROCESSING is set to Y1 E wn 22 17 Configuration options related to external references TAGFILES The TAGFILES tag can be used to specify one or more tag files For each tag file the location of the external documentation should be added The format of a tag file without this location is as follows TAGFILES filel file2 Adding location for the tag files is done as follows TAGFILES filel locl file2 loc2 where locl and loc2 can be relative or absolute paths or URLs See the section Linking to external documentation for more information about the use of tag files Ge
7. Amsc 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 xx Acknowledgment from server x void Ack bool ok 5 x Receiver class Can be used to receive and execute commands After execution of a command the receiver will send an acknowledgment Amsc Receiver Sender Receiver lt Sender label Command URL ref Command Receiver gt Sender label Ack URL ref Sender Ack ID 1 endmsc class Receiver public Generated by Doxygen 170 Special Commands x Executable a command on the server void Command int commandId See also section mscfile 23 132 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 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 doe
8. Generated by Doxygen 202 Perl Module Output format Generated by Doxygen Chapter 28 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 option OUTPUT_LANGUAGE in the configuration file with default name and known as Doxyfile Currently version 1 8 6 40 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 Latvian Lithuanian Mace donian Norwegian Persian Polish Portuguese Romanian Russian Serbian SerbianCyrillic Slovak Slovene Spanish Swedish Turkish Ukrainian and Vietnamese The table of information related to the supported languages follows It is sorted by language alphabetically 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 Muhammad Bashir Al Noimi m
9. 23 71 par paragraph title paragraph If a paragraph title is given this 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 x class Test Normal text par 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 FF FF F FF OF class Test 23 72 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 par
10. Before continuing with the next section add the above URL without the test part to the SEARCHENGINE_URL tag in doxygen s configuration file SEARCHENGINE_URL http yoursite com path to cgi doxysearch cgi 13 1 2 1 Single project index To use the external search option make sure the following options are enabled in doxygen s configuration file SEARCHENGINE YES SERVER_BASED_SEARCH YES EXTERNAL_SEARCH YES This will make doxygen generate a file called searchdata xml in the output directory configured with OUTP UT_DIRECTORY You can change the file name and location with the SEARCHDATA_FILE option The next step is to put the raw search data into an index for efficient searching You can use doxyindexer for this Simply run it from the command line doxyindexer searchdata xml This will create a directory called doxysearch db with some files in it By default the directory will be created at the location from which doxyindexer was started but you can change the directory using the o option Copy the doxysearch db directory to the same directory as where the doxysearch cgi is located and rerun the browser test by pointing the browser to http yoursite com path to cgi doxysearch cgi test You should now get the following message Test successful Now you should be enable to search for words and symbols from the HTML output 13 1 2 2 Multi project index In case you have more than one doxygen project and t
11. PURE 0 THIS_ THIS DECLARE_REGISTRY_RESOURCEID DECLARE_PROTECT_FINAL_CONSTRUCT DECLARE_AGGREGATABLE Class DECLARE_REGISTRY_RESOURCEID Id ECLARE_MESSAGE_MAP EGIN_MESSAGE_MAP x MX ESSAGE_MAP x COM_MAP x _COM_MAP x PROP_MAP x ROP_MAP x MSG_MAP x G_MAP x _PROPERTY_MAP x ROPERTY_MAP x OBJECT_MAP x JECT_MAP x ECLARE_VIEW_STATUS STDMETHOD a HRESULT a ATL_NO_VTABLE _declspec a BEGIN_CONNECTION_POINT_MAP x END_CONNECTION_POINT_MAP x ti H zZ Q aie ZaQazZ2zezZ ol Hz az e Qu YZZ v zZ 4 00 oz w DECLARE_DYNAMIC class IMPLEMENT_DYNAMIC classl class2 NM 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 NM ASSERT x assert x ASSERT_VALID x assert x TRACEO x printf x A OS_ERR A B A B __ cplusplus Y DECLARE_OLECREATE class BEGIN_DISPATCH_MAP class1l class2 BEGIN_INTERFACE_MAP class1 class2 INTERFACE_PART class id name Generated by Doxygen 58 Preprocessing END_INTERFACE_M
12. lt ul gt More text here Note In this case the indentation is not important Using arg or li For compatibility with the Qt Software s internal documentation tool qdoc and with KDoc doxygen has two com mands that can be used to create simple unnested lists See arg and li for more info Generated by Doxygen Chapter 7 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 7 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 me
13. 10 10 10 1000 1000 1000 which will look as follows Right Center Left 10 10 10 1000 1000 1000 5 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 Generated by Doxygen 36 Markdown This is a paragraph introducing 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 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 1 A class 2 class Dummy 3 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 5 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 Head
14. Finally to put invisible comments inside comment blocks HTML style comments can be used x lt This is a comment with a comment block gt Visible text Generated by Doxygen Chapter 25 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 precise and a number of the examples given are of poor quality Here is the list of tags supported by doxygen 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 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 lt exception cref member gt Identifies the exception a method can throw lt include gt Can be used to import a piece of XML from an external file Ignored by doxygen at the moment lt inheritdoc gt Can be used to insert the documentation of a member of a base class into the documen tation of a member of a derived class that reimplements it lt item gt List item Can only be used inside a
15. This tag requires that the tag GENERATE_LATEX is set to Y LATEX_SOURCE_CODE If the LATEX_SOURC Gl Ss T __CODE tag is set to YES then doxygen will include source code with syntax highlighting in the ATEX output Note that which sources are shown also depends on other settings such as SOURCE_BROWSER The default value is NO This tag requires that the tag GENERATE_LATEX is set to Y E S LATEX_BIB_STYLE The LATEX_BIB_STYLE tag can be used to specify the style to use for the bibliography e g plainnat or ieeetr See http en wikipedia org wiki BibTex and cite for more info The default value is plain This tag requires that the tag GENERATE_LATEX is set to Y E un 22 10 Configuration options related to the RTF output GENERATE_RTF Ifthe G EN ERATE_RTF tag is set to Y ES doxygen will generate RTF output The RTF output is optimized for Word 97 and may not look too pretty with other RTF readers editors The default value is NO 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 The default directory is rt f This tag requires that the tag GENERATE_RTF is set to YES COMPACT_RTF Ifthe COMPACT_RTF tag is set to YES may be useful for small projects and may help to save some trees in general The default value
16. My brother Frank for rendering the logos Harm van der Heijden for adding HTML help support Wouter Slegers of Your Creative Solutions for registering the www doxygen org domain e Parker Waechter for adding the RTF output generator 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 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 Introduction Generated by Doxygen Chapter 2 Installation First go to the download page to get the latest distribution if you have not downloaded doxygen already 2 1 Compiling from source on UNIX If you downloaded the source distribution you need at least the following to build the executable e The GNU tools flex bison libiconv and GNU make and strip e In order to generate a Makefile for your platform you need per1 e The configure script assume the availability of standard UNIX tools such as sed date find uname mv cp cat echo tr cdand rm To
17. 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 documentation 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 g
18. This tag requires that the tag ALPHABETICAL_INDEX is set to YES 22 8 Configuration options related to the HTML output GENERATE_HTML lf the GENERATE_HTML tag is set to YES doxygen will generate HTML output The default value is YES 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 The default directory is html This tag requires that the tag GENERATE_HTML is set to YES 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 The default value is html This tag requires that the tag GENERATE_HTML is set to YES 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 which is dependent on the configuration options used e g the setting GENERATE _TREEVIEW It is highly recom mended 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 See also section Doxygen usage for information on how to generate the default header tha
19. param s a constant character pointer return The test results sa Test Test testMeToo and publicVar int testMe int a const char xs A pure virtual member Ir Asa testMe param cl the first argument param c2 the second argument virtual void testMeToo char cl char c2 0 A public variable jal Details int publicVar A function variable Ie Details int handler int a int b 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 xx Brief description e g using only a few words
20. 34 Markdown In addition doxygen provides a similar way to link a documented entity The link text ref MyClass 5 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 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 5 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 a
21. ENABLE_PREPROCESSING YES MACRO_EXPANSION YES EXPAND_ONLY_PREDEF YES SEARCH_INCLUDES YES FULL_PATH_NAMES YES STRIP_FROM_PATH OTDIR PREDEFINED USE_TEMPLATECLASS Q_EXPORT Y Y Y Y Y Y U QArrayT QArray QListT QList QDictT QDict QQueueT QQueue QVectorT QVector QPtrDictT QPtrDict QIntDictT QIntDict QStackT QStack QDictIteratorT QDictIterator QListIteratorT QListIterator QCacheT QCache OCachelteratorT 0Cachelterator QIntCacheT QIntCache QIntCacheIteratorT QIntCacheIterator QIntDictIteratorT QIntDictIterator QPtrDictIteratorT QPtrDictIterator INPUT QTDIR doc QTDIR src widgets QTDIR src kernel QTDIR src dialogs QTDIR src tools FILE_PATTERNS cpp h gq doc INCLUDE_PATH QTDIR include RECURSIVE YES For the Qt 2 1 sources recommend to use the following settings PROJECT_NAME Qt PROJECT_NUMBER 2 1 HIDE_UNDOC_MEMBERS YES HIDE_UNDOC_CLASSES YES SOURCE_BROWSER YES INPUT QTDIR sre FILE_PATTERNS cpp h qx doc Generated by Doxygen 134 Configuration RECURSIVE YES EXCLUDE_PATTERNS codec cpp moc_ compat x 3rdparty ALPHABETICAL INDEX YES COLS_IN_ALPHA_INDEX 3 IGNORE_PREFIX 0 ENABLE_PREPROCESSING YES MACRO_EXPANSION YES INCLUDE_PATH QTDIR include PREDEFINED Q PROPERTY x Q_OVERRIDE x
22. Manual for version 1 8 7 Written by Dimitri van Heesch 1997 2014 Contents 1 2 2 1 22 2 3 2 4 25 2 6 User Manual Introduction Installation Gompiling from source 9m UNIX ociosa a A a a a a Installing the binaries CRUE gt aro a dd ida e eh a ek der dd SS Known compilation problems for UNIX o e ee Compiling from source on Windows 2 e e Installing the binaries DN VIII gt ete cae a ak Bo da ee Sa ok he we a ee ee ae ow Tools used to develop doxygen 2 2 ee 3 Getting Started 3 1 3 2 3 3 3 4 Step 0 Check if doxygen supports your programming language o Step 1 Creating a configuration file gt lt se ee eee ew ee ee Sle El REI IRON ono ce ek ee a a OS bod ee a a a Sal 3 3 1 HTML output 3 3 2 LaTeX output 3 3 3 RTF output 3 3 4 XML output 399 Manpage OUIDUL i gion bate a Sek RG A Sw ea e Bb eS 39 6 DocBook ouiput 6 5 4 0028 a ewe bee be ee ee Ba ee Step 3 Documenting 4 Documenting the code 4 1 WE SOLICES o o e kek ae ae RB a Ee a Re ec da Special comment blocks 4 1 1 Comment blocks for C like languages C C C Objective C PHP Java 4 1 1 1 Putting documentation after members Le EXIMPRES on cle acne Gf a eh AG A A eet ee 4 11 9 Documentation al oiher places o oroo core ira ee bee be ees 41 2 Comment blocks im PYINON lt s oc
23. Q_EXPORT Q_ENUMS x QT_STATIC_CONST static const _WS_X11_ INCLUDE_MENUITEM_DEF EXPAND_ONLY_PREDEF YES EXPAND_AS_DEFINED Q OBJECT_FAKE Q_OBJECT ACTIVATE_SIGNAL_WITH_PARAM Q_VARIANT_AS 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 23 Special Commands 23 1 Introduction All commands in the documentation start with a backslash Y 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 addition 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 23 121 So eila s cc ee db 23 110 o A PR eae de a 23 95 o A Ge eh Ge aa 23 130 NAGGHOQIOUP co cc ee ie we ee de a 23 2 NOTES eon co ee ae BE a ite eae aed Gated 23 132 MANGO es fa Sees a A ee RAS Bind Bu
24. The default value is NO This tag requires that the tag GENERATE_HTMLHELP is set to YES ERAT GENERATE_QHP If the GEN The default value is NO This tag requires that the tag GENERATE_HTML is set to YES QCH_FILE If the QHG_LOCATION tag is specified the QCH_FIL I E__OHP tag is set to Y ES to add extra items for group members to the table of ES 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 E tag can be used to specify the file name of the resulting qch file The path specified is relative to the HTML output folder This tag requires that the tag GENERATE_QHP is set to YES Generated by Doxygen 120 Configuration 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 The default value is org doxygen Project This tag requires that the tag GENERATE_QHP is set to YES 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 The default value is doc This tag requires that the tag GENERATE_QHP is set to YES QHP_CUST_FILTER_NAME
25. lt option gt or both Inside the search box use the lt cursor down key gt to jump into the search results window the results can be navigated using the lt cursor keys gt Press lt Enter gt to select an item or lt escape gt to cancel the search The filter options can be selected when the cursor is inside the search box by pressing lt shift gt lt cursor down gt Also here use the lt cursor keys gt to select a filter and lt Enter gt or lt escape gt to activate or cancel the filter option The default value is YES This tag requires that the tag GENERATE_HTML is set to YES SERVER_BASED_SEARCH When the SERVER_BASED_SEARCH tag is enabled the search engine will be im plemented using a web server instead of a web client using Javascript There are two flavors of web server based searching depending on the EXTERNAL_SEARCH setting When disabled doxygen will generate a PHP script for searching and an index file used by the script When EX TERNAL SEARCH is enabled the indexing and searching needs to be provided by external tools See the section External Indexing and Searching for details The default value is NO This tag requires that the tag SEARCHENGINE is set to YES EXTERNAL SEARCH When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP script for searching Instead the search results are written to an XML file which needs to be processed by an external index
26. 63 itcl body ns itcl_class itcl_method_x argx 64 puts Sargx OK Generated by Doxygen 30 Documenting the code 65 67 oo define ns oo_class 68 public Outside defined variable c oo_var_out 69 Inside oo_class 70 variable oo_var_out 71 73 Documented global proc c glob_proc 74 param in arg Argument 75 proc glob_proc arg puts arg 77 variable glob_var lt Documented global var lc glob_varl 78 with newline 79 lt and continued line 81 end of file 4 2 Anatomy of a comment 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 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 m
27. DES 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 The default value is YES This tag requires that the tag HAVE_DOT is set to YES CALL_GRAPH If the CALL_GRAPH tag is set to YES then doxygen will generate a call dependency 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 The default value is NO This tag requires that the tag HAVE_DOT is set to YES CALLER_GRAPH Ifthe CALLER_GRAPH tag is 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 a run So in most cases it will be better to enable caller graphs for selected functions only using the callergraph command The default value is NO This tag requires that the tag HAVE_DOT is set to YES GRAPHICAL HIERARCHY If the GRAPHICAL HIERARCHY tag is set to YES then doxygen will graphical hi erarchy of all classes instead of a textual one The default value is YES This tag requires that the tag HAVE_DOT is set to Y Gl e S DIRECTORY _GRAPH lf the DIRECTORY_GRAPH tag is set to YES then doxygen will sho
28. 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 196 Doxygen s internals options are available through 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
29. See also sections code endverbatim and verbinclude 23 161 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 sections manonly rtfonly latexonly ntmlonly and docbookonly 23 162 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 Generated by Doxygen 23 163 177 23 163 10 This command writes an at sign 4 to the output The at sign has to be escaped in some cases because doxygen uses it to detect JavaDoc commands 23 164 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 X english This is English dutch Dit is Nederlands german Dies ist Deutsch output for all languages 23 165 amp This command writes the amp character to the output This character has to be escaped because it has a special meaning in HTML 23 166 This command writes the character to the output This character has to be escape
30. These packages are needed during the compilation process if you use a GitHub snapshot of doxygen the official source releases come with pre generated sources 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 tar zxvf doxygen x y z src tar gz to unpack the sources you can obtain tar from e g http gnuwin32 sourceforge net packages html Alternatively you can use an unpack program like 7 Zip see http www 7 zip org or use the build in unpack feature of modern Windows systems Now your environment is setup to build doxygen Inside the doxygen x y z directory you will find a winbuild 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 project org Also read the next section for additional tools you may need to install to run doxygen with certain features enabled 2 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 se
31. broken bar broken vertical bar amp sect section sign e uml diaeresis spacing diaeresis COPy copyright sign O gordf feminine ordinal indicator laquo left pointing double angle quotation mark left pointing guillemet not not sign Generated by Doxygen 184 HTML commands amp shy amp reg amp macr amp deg amp plusmn amp sup2 amp sup3 amp acute amp micro amp para amp middot amp cedil amp supl amp ordm amp raquo amp fracl4 amp fracl2 amp frac34 amp iquest amp Agrave amp Aacute amp Acirc Atilde Auml sAring AElig amp Ccedil amp Egrave amp Hacute amp ECirc amp Euml amp Igrave amp lacute amp lcirc amp Iuml SETH soft hyphen discretionary hyphen registered sign registered trade mark sign macron spacing macron overline APL overbar degree sign plus minus sign plus or minus sign 4 superscript two superscript digit two squared 2 superscript three superscript digit three cubed 3 acute accent spacing acute micro sign u pilcrow sign paragraph sign J middle dot Georgian comma Greek middle dot cedilla spacing cedilla superscript one superscript digit one 1 masculine ordinal indicator right pointing double angle quotation mark right pointing guillemet vulgar fraction one quarter
32. bug that results in a compiler errors like this ce_parse cpp 348 member class CPPValue yyalloc yyvs with constructor not al lowed in union This problem has been solved in version 1 35 versions before 1 31 will also work Sun compiler problems It appears that doxygen doesn t work properly if it is compiled with Sun s C WorkShop 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 suc
33. class ClassDef a namespace class NamespaceDef a group class Groupe 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 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 declaredinsrc 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
34. 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 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 customdoxygen css is the default cascading style sheet used by doxygen It is recommended only to look into this file and overrule some settings you like by putting them in a separate stylesheet and referencing that extra file via HTML_EXTRA_STYLESHEET You should edit these files and then reference them from the config file e HTML_HEADER header html e HTML_FOOTER footer html HTML_STYLESHEET customdoxygen css obsolete Generated by Doxygen 14 2 Changing the layout of pages 75 Note it is not longer recommended to use HTML_STYLESHEET this way as it make it difficult to upgrade to a newer version of doxygen Use HTML_EXTRA_STYLESHEET instead See the documentation of the HTML_HEADER tag for more information about the possible meta commands y
35. 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 Generated by Doxygen 76 Customizing the Output 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_T REEVIEW 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 the default then doxygen will fill in an appropriate language specific title 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 goog
36. h to filter out the source files in the directo ries If left blank the following patterns are tested c cc CXX cpp C x java ii 1XX 1pp 1 inl idl ddl odl h x hh hxx x hpp ht cs x d php php4 php5 phtml inc m markdown md mm dox py 90 f for tcl vhd vhdl ucf qsf asand js RECURSIVE The RECURSIVE tag can be used to specify whether or not subdirectories should be searched for input files as well The default value is NO 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 The default value is NO 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 Note that the wildcards are matched against the file with absolute path so to exclude all test directories for example use the pattern test x
37. 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 23 119 htmlinclude lt file name gt This command includes the file lt file name gt as is in the HTML documentation The command is equivalent to pasting the file in the documentation and placing ntmlonly 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 23 120 latexinclude lt file name gt This command includes the file lt file name gt as is in the ATEX documentation The command is equivalent to pasting the file in the documentation and placing latexonly and endlatexonly 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 23 121 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 Equivalent to e and em To emphasize multip
38. lt list gt context lt list type type gt Starts a list supported types are bullet or number and table A list con sists of a number of lt item gt tags A list of type table is a two column table which can have a header lt listheader gt Starts the header of a list of type table lt para gt Identifies a paragraph of text lt param name paramName gt Marks a piece of text as the documentation for parameter param Name Similar to using param lt paramref name paramName gt Refers to a parameter with name paramName Similar to using a lt permission gt ldentifies the security accessibility of a member Ignored by doxygen lt remarks gt Identifies the detailed description lt returns gt Marks a piece of text as the return value of a function or method Similar to using return lt s cref member gt Refers to a member Similar to ref lt seealso cref member gt Starts a See also section referring to member Similar to using isa member 192 XML commands lt summary gt Identifies the brief description Similar to using brief lt term gt Part of a lt list gt command lt typeparam name paramName gt Marks a piece of text as the documentation for type parameter paramName Similar to using param lt typeparamref name paramName gt Refers to a parameter with name paramName Similar to using a lt value gt Identifies a property Ignored by doxygen Here is a
39. not including the namespace part Generated by Doxygen 110 Configuration Note This option is not very useful if HIDE _SCOPE_NAMES is set to Y This option applies only to The default value is NO ES the class list not to the alphabetical list 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 disabling STRICT_PROTO_MATCHING doxygen will still accept a match between prototype and implementation in such cases The default value is NO EN h GENERATE_TODOLIST TheG ERATE_ TODOLIST tag can be used to enable Y ES or disable NO the todo list This list is created by putting todo commands in the documentation The default value is Y GENERATE_TESTLIST TheG ES EN h ERATE I ESTLIST tag can be used to enable YES or disable NO the test list This list is created by putting West commands in the documentation The default value is Y ES GENERATE_BUGLIST The GENERATE EN __BUGLIST tag can be used to enable Y ES or disable NO the bug list This list is created by putting bug commands i
40. right floor left pointing angle bracket bra right pointing angle bracket ket lozenge black spade suit d black club suit shamrock de black heart suit valentine Y black diamond suit lt gt quotation mark APL quote ampersand 8 less than sign lt greater than sign gt latin capital ligature OE CE latin small ligature oe latin capital letter S with caron latin small letter s with caron 8 latin capital letter Y with diaeresis Y Generated by Doxygen 190 HTML commands e amp Circ modifier letter circumflex accent o e amp tilde small tilde e ensp en space e emsp em space e amp thinsp thin space EZWNJ zero width non joiner EZWJ zero width joiner amp lxrm left to right mark amp rim right to left mark ndash en dash amp mdash em dash 1squo left single quotation mark e rsquo right single quotation mark amp sbquo single low 9 quotation mark amp ldquo left double quotation mark rdquo right double quotation mark amp bdquo double low 9 quotation mark dagger dagger e amp Dagger double dagger e permil per mille sign o e lsaquo single left pointing angle quotation mark lt e rsaquo single right pointing angle quotation mark euro euro sign Doxygen extensions amp tm trade mark sign TM Sapos apostrophe
41. 1 x class C2 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 xx defgroup group4 The Fourth Group Generated by Doxygen 7 2 Member Groups 45 x ingroup group3 Group 4 is a subgroup of group 3 kx x ingroup group2 x brief class C3 in group 2 class C3 x ingroup group2 x brief class C4 in group 2 class C4 x x ingroup group3 x brief class C5 in link group3 the third group endlink class Ch d x x 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 x namespace N1 xx file x ingroup group3 x brief this file in group 3 x defgroup group5 The Fifth Group 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 end of group5 xx addtogroup groupl More documentation for the first group x f x another function in group 1 x void func2 yet another function in group 1 void func3 xx end of groupl 7 2 Member Groups If a compound e g a class or
42. 104 DIA_PATH 129 DIAFILE_DIRS 132 DIRECTORY_GRAPH 131 DISABLE_INDEX 120 DISTRIBUTE_GROUP_DOC 107 Doc 5 docbook 16 DOCBOOK_OUTPUT 127 DOCSET_BUNDLE_ ID 118 Generated by Doxygen INDEX 211 DOCSET_FEEDNAME 118 DOCSET_ PUBLISHER _ID 118 DOCSET_PUBLISHER_NAME 119 DOT_CLEANUP 132 DOT_FONTNAME 130 DOT_FONTPATH 130 DOT_FONTSIZE 130 DOT_GRAPH_MAX_NODES 132 DOT_IMAGE_FORMAT 131 DOT_MULTI_TARGETS 132 DOT_NUM_THREADS 129 DOT_PATH 131 DOT_TRANSPARENT 132 DOTFILE_DIRS 132 DOXYFILE_ENCODING 103 ECLIPSE_DOC_ID 120 ENABLE_PREPROCESSING 127 ENABLED_SECTIONS 110 ENUM_VALUES_PER_LINE 121 EXAMPLE_PATH 112 EXAMPLE_PATTERNS 113 EXAMPLE_RECURSIVE 113 EXCLUDE 112 EXCLUDE_ PATTERNS 112 EXCLUDE_SYMBOLS 112 EXCLUDE_SYMLINKS 112 EXPAND_AS_ DEFINED 128 EXPAND_ONLY_PREDEF 127 EXT_LINKS_IN_WINDOW 121 EXTENSION_MAPPING 106 EXTERNAL_GROUPS 129 EXTERNAL_PAGES 129 EXTERNAL_SEARCH 122 EXTERNAL_SEARCH_ID 123 EXTRA_PACKAGES 124 EXTRA_SEARCH_MAPPINGS 123 EXTRACT_ALL 107 EXTRACT_ANON_NSPACES 108 EXTRACT_LOCAL_CLASSES 108 EXTRACT_LOCAL_METHODS 108 EXTRACT_PACKAGE 108 EXTRACT_PRIVATE 108 EXTRACT_STATIC 108 features 91 FILE_PATTERNS 112 FILE_VERSION_ FILTER 110 FILTER_PATTERNS 113 FILTER_SOURCE_ FILES 113 FILTER_SOURCE_PATTERNS 113 flex 7 FORCE_LOCAL_INCLUDES 109 FORMULA_FONTSIZE 121 FORMULA_TRANSPARENT 121 FULL_PATH_NAMES 104 GENERATE_AUTOGEN_DEF 127 GENERATE_B
43. 128 SEARCHDATA_FILE 123 SEARCHENGINE 122 SEARCHENGINE_URL 123 SEPARATE_MEMBER_PAGES 105 SERVER_BASED_SEARCH 122 SHORT_NAMES 105 SHOW_FILES 110 SHOW_GROUPED_MEMB_INC 109 SHOW_INCLUDE_ FILES 109 SHOW_NAMESPACES 110 SHOW_USED_FILES 110 SIP_SUPPORT 107 SKIP_FUNCTION_MACROS 128 SORT_BRIEF_DOCS 109 SORT_BY_SCOPE_NAME 109 SORT_GROUP_NAMES 109 SORT_MEMBER_DOCS 109 SORT_MEMBERS_CTORS_1ST 109 SOURCE_BROWSER 113 SOURCE_TOOLTIPS 114 STRICT_PROTO_MATCHING 110 strip 7 STRIP_CODE_COMMENTS 113 STRIP_FROM_INC_PATH 105 STRIP_FROM_PATH 105 SUBGROUPING 107 TAB_SIZE 105 TAGFILES 128 TCL_SUBST 106 TEMPLATE_RELATIONS 130 Generated by Doxygen INDEX 213 TOC_EXPAND 119 TREEVIEW_WIDTH 121 TYPEDEF_HIDES_STRUCT 107 UML_LIMIT_NUM_FIELDS 130 UML_LOOK 130 USE_HTAGS 114 USE_MATHJAX 121 USE_MDFILE_AS_MAINPAGE 113 USE_PDFLATEX 124 VERBATIM_HEADERS 114 WARN_FORMAT 112 WARN_IF_DOC_ERROR 111 WARN_IF_UNDOCUMENTED 111 WARN_LOGFILE 112 WARN_NO_PARAMDOC 111 WARNINGS 111 XML 16 XML_OUTPUT 126 XML_PROGRAMLISTING 126 Generated by Doxygen
44. 152 htmlonly block 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 specific attributes Generated by Doxygen 174 Special Commands Normally the contents between htmlonly and endhtmlonly is inserted as is When you want to insert a HTML fragment that has block scope like a table or list which should appear outside lt p gt lt p gt this can lead to invalid HTML You can use htmlonly block to make doxygen end the current paragraph and restart it after endhtmlonly Note environment variables like HOME are resolved inside a HTML only block See also section manonly latexonly rtfonly xmlonly and docbookonly 23 153 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 rtf 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 foun
45. 22 11 GENERATE_DEPRECATEDLIST 22 3 MAN LINKS ooo aras a a ee as ec 22 11 GENERATE_DOCBOOK 22 13 MAN OUTPUT ociosas p aeaa a te ee bees 22 11 GENERATE_DOCSET occo ee ani 22 8 MAN SUBDIR ae saaug a ee 22 11 GENERATE_ECLIPSEHELP 22 8 MARKDOWN_SUPPORT 5 22 2 GENERATE_HTML 0 2 66 ce be es 22 8 MATHJAX_CODEFILE pes sc ia eee nee 22 8 GENERATE_HTMLHELP 22 8 MATHJAX_EXTENSIONS 0 00 0 0c eee 22 8 GENERATE_LATEX 0 cee a a 22 9 MATHJAX_FORMAT 2 05 00 00 eee eee 22 8 GENERATE LEGEND o 22 18 MATHJAX_RELPATH o o on 22 8 GENERATE_MAN ou coama cir cc e a 22 11 MAX_DOT_GRAPH_DEPTH 22 18 GENERATE_PERLMOD 22 15 MAX_INITIALIZER_LINES 22 3 GENERATE QHP ooo co puero ee 22 8 MSOFILE DIRS o oe enaa na ee ed 22 18 GENERATE_RTF 0000000 22 10 MSCGEN_PATH coco sisigan A ewe ale 22 18 GENERATE_TAGFILE 22 17 MULTILINE_CPP_IS BRIEF 22 2 GENERATE_TESTLIST 22 3 OPTIMIZE_FOR_FORTRAN 22 2 GENERATE_TODOLIST 22 3 OPTIMIZE_OUTPUT_FOR C 22 2 GENERATE_TREEVIEW 22 8 OPTIMIZE_OUTPUT_ JAVA o o o 22 2 GENERATE XML oc sooo pere biR RES omn 22 12 OPTIMIZE_OUTPUT_VHDL 22 2 Generated by Doxygen 22 2 Project related configura
46. 23952 Allenton AMONIO tetp cr ee o Ba Be ee a ae et ee 150 23 93 authori isto authors oos ena ek eb a Re eR OR ee OR eo deo 150 2354 AUTOS list Ol QUID cocina RA be ee eee EE PES ES he wd 150 23 599 TEST brier desciple Ga a ee eR Se ea A we ee me ee a 150 23 06 bug 1 DUQUSSCHDIICN ss e e as a eS ee ee aE Ree eee ee 151 23 37 Wond isectomlabey e oci ace a ae ar ae A A OS BADR a eR Bes 151 23 58 copyright copyright description lt sse sc tae tiba eredi rides adri iett 152 29 59 Male dale GESENDION j o c i co maos be e AA a ea a Woa g 152 23 60 deprecated description cr omo cocer aa aa eR a a A ae ek 152 23 61 details detailed description gt c co ca a Pak Ee A be ee eS 152 e A E E ay oh cet ete A he Bk E eek eae Ack eee dy amp 152 23 63 Bis seCtiOnaabel sac 6 44 a5 2h bw ee Pee bee ba hee Pee Peed hee 152 a la oo eS kan AAA 153 ESO NGI pune AAA eee a ie A A Oe bee ere eee Baa ee E 153 23 66 lexception lt exception object gt exception description e ee eee 153 23 67 UW SGCHOMIMDEN 26 45 tbh eee eee he PE bee Ge OE a ee dc ed 153 2368 Snel section label 6 4 2525 0250 6 Ped howe eevee EN GS eee be La bes 154 23 69 invariant description of invariant 6 2 sisa ee ee RA ee A 154 PorU MOS TOR o OE Ee eee ee De ea Se a oe Oe a ae aS 154 23 71 par paragraph title paragraph 2 24 a aala beu ee a 155 23 72 param dir lt parameter name gt parameter description
47. 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 23 56 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 lbug 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 23 57 1 cond section label 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 Acond and endcond can be included by adding its section label to the ENABLED_SECTIOw NS configuration option If the section label is omitted the section will be excluded from processing unconditionally The section label can be a logical expression
48. Bell Labs The other options in this section have no effect if this option is set to NO The default value is NO DOT_NUM_THREADS The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed to run in parallel When set to 0 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 Minimum value 0 maximum value 32 default value 0 This tag requires that the tag HAVE_DOT is set to YES Gl Generated by Doxygen 130 Configuration DOT_FONTNAME When you want a differently looking font n the dot files that doxygen generates you can specify the font name using DOT_FONTNAME You need to make sure dot is able to find the font which can be DOT_FONTSIZE The DOT_FONTSIZ 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 The default value is Helvetica This tag requires that the tag HAVE_DOT is set to Y Gl S E tag can be used to set the size in points of the font of dot graphs Minimum value 4 maximum value 24 default value 10 This tag requires that the tag HAVE_DOT is set to Y J Ss DOT_FONTPATH By default doxygen will tell dot to use the default font as specified with DOT _FONTNAME If you specify a different fo
49. Doxywizard usage Output format s to generate M HTML plain HTML with frames and a navigation tree prepare for compressed HTML chm _ With search function requires PHP enabled web server M La O as intermediate format for hyperlinked PDF gt as intermediate format for PDF as intermediate format for PostScript Man pages 1 Rich Text Format RTF 2 XML Eo cancel Figure 21 4 Wizard dialog Output to produce You can select one or more of the output formats that doxygen should produce For HTML and lATpX there are additional options Diagrams to generate O No diagrams Use built in class diagram generator Use dot tool from the GraphViz package to generate M Class diagrams M Collaboration diagrams Y Include dependency graphs Y Included by dependency graphs M Overall Class hierarchy _ Call graphs GOD cance Figure 21 5 Wizard dialog Diagrams to generate Generated by Doxygen 99 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 packages for MacOSX this tool is already included 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 wid
50. English users Here the maintainer of the language translator should implement at least that one particular method Generated by Doxygen 207 What says the base class of a language translator If the language translator class inherits from any adapter class then maintenance is needed In such case the language translator is considered not 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 notifying the user that the language translation is not up to date because of that some sentences in
51. GENERATE_HTML is set to YES 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 The default value is NO This tag requires that the tag GENERATE_HTML is set to YES FORMULA_FONTSIZE Use this tag to change the font size of IATEX formulas included as images in the HTML documentation When you change the font size after a successful doxygen run you need to manually remove any form_ png images from the HTML output directory to force them to be regenerated Minimum value 8 maximum value 50 default value 10 This tag requires that the tag GENERATE_HTML is set to YES 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_x png files in the HTML output directory before the changes have effect The default value is YES This tag requires that the tag GENERATE_HTML is set to Y Gl E Ss USE_MATHJAX Enable the USE_MATHJAX option to render IATEX formulas using MathJax see http www mathjax org which uses client side Javascript for the rendering instead of using prerendered bitmaps Use this if you do not have IATEX installed or if you want to formula
52. GENERATE_TREEVIEW or the search engine require a browser that supports Dynamic HTML and Javascript enabled Generated by Doxygen 16 Getting Started 3 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_2onl To get the best results for PDF output you should set the PDF_HYPERLINKS and USE_PDFLATEX tags to Y In this case the Makefile will only contain a target to build refman pdf directly E un 3 3 3 RTF output Doxygen combi
53. If the QHP_CUST_FILTER_NAME tag is set it specifies the name of a custom filter to add For more information please see Ot Help Project Custom Filters This tag requires that the tag GENERATE_QHP is set to YES QHP_CUST_FILTER_ATTRS The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the custom filter to add For more information please see Ot Help Project Custom Filters This tag requires that the tag GENERATE_QHP is set to YES 5a 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 This tag requires that the tag GENERATE_QHP is set to YES QHG LOCATION The QHG_LOCATION tag can be used to specify the location of Qt s qhelpgenerator If non GENERATE_ECLIPSEHELP If the GENERATE_ECLIPSEH empty doxygen will try to run qhelpgenerator on the generated qhp file This tag requires that the tag GENERATE_QHP is set to YES T P tag is set to YES additional index files will be generated together with the HTML files they form an Eclipse help plugin To install this plugin and 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 sa
54. Linux 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 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 Lists shows how to create lists 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 4 Introduction Section Preprocessing explains how doxygen deals with 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 External Indexing and Searching shows how use the external search and index tools e Section Customizing the output explains how you can customize the output generated
55. Mac users are advised to set this option to NO CASE_SENSE_NAMES Ifthe CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file names The default value is system dependent T HIDE_SCOPE_NAMES If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with their full class and namespace scopes in the documentation If set to YES the scope will be hidden The default value is NO SHOW_INCLUDE_FILES If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of the files that are included by a file in the documentation of that file The default value is YES SHOW_GROUPED_MEMB INC Ifthe SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each grouped member an include statement to the documentation telling the reader which file to include in order to use the member The default value is NO T FORCE_LOCAL INCLUDES If the 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 The default value is NO T INLINE_INFO lf the INLINE_INFO tag is set to YES then a tag inline is inserted in the documentation for inline members The default value is YES SORT_MEMBER DOCS Ifthe SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the detailed doc umentation of file and class members alphabetically by member
56. Normal C C and Fortran comments will always remain visible Fl un The default value is Y Generated by Doxygen 114 Configuration 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 The default value is NO 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 The default value is NO REFERENCES_LINK_SOURCE If the REFERENCES _LINK_SOURCE tag is set to YES and SOURCE_BRO WSER tag is set to YES then the hyperlinks from functions in REFERENCES_RELATION and REFEREN CED_BY_RELATION lists will link to the source code Otherwise they will link to the documentation S The default value is Y Gl SOURCE_TOOLTIPS If SOURCE_TOOLTIPS is enabled the default then hovering a hyperlink in the source code will show a tooltip with additional information such as prototype brief description and links to the defini tion and documentation Since this will make the HTML file larger and loading of large files a bit slower you can opt to disable this feature The default value is YES This tag requires that the tag SOURCE_BROWSER is set to Y Gl S USE_HTAGS If the USE_HTAGS tag is set to YES then the references to source code wil
57. So VOU ce m e ache ee he bee hee ed be bbb ee ede edt dd dc bh 176 Ae ee at ee ee en RR ot ae ewe See Oe 176 MHD o oo ode ee ack Sintec har okt hes Se Oe Rh GON Bon Ah os ug lets ik Gad a ae we eee Ree 177 SRB LAMA ORAR NE 177 Generated by Doxygen CONTENTS IX POE a th Se eee REDRESS Sw SESE ER eRe wee See de a 177 PA rie e Hom oe ances SP ae is a Kew ee Ge a ewes eh Aes oe at cee he Ok at Bee e 177 BO Oe ad Dae hey Bienes te i St EA ar he GS Bae ce es BP we cba th we GW a ie ee 177 2D sl a Se ae Eh eee a eS as at PS eS Gee e aE we Ses Se es ge a 177 o raat dk a a che gs Be ce Hy de Beer ee hh ce Ge At By atta atte O Gendt nea He ic eae ae S 177 Pelee 2 63 Odi eo dott ous a GO OG ERE RTA Ae EEE EE AMA EERE ES BE heb eS 177 Ue a sen eta a eee ae Sole Gs SO Gt ale Sey Gots ec oe ee a a lah ails Bete ot 178 o RR ee ee Sed ep ce ke eek eee ae 178 A Rag ee lade GE ah a ty tg HO BM Gk ER eGR Bae Ee a a a ae ee Mel ea ye a S 178 E AS 178 CANTES Sas ds ds ds de do e de a dd di 178 A PhS ook eee Pee beds Pee behead es 178 24 HTML commands 181 25 XML commands 191 lll Developers Manual 193 26 Doxygen s internals 195 27 Perl Module Output format 199 2r e Goa Gt es BO oe ee A ee Ea DES ERS GS Raa Rw a E 199 27 2 Usingihne LaTeX generalon oc io mr ew Ae eR Re wae 199 27 2 1 Creation of PDF and DV output oe sadida d ee we ee be hee 200 P73 Documentation to Mal s s ss rec r Fea we ee RS ae eee EGE ee ee Re es 201 27A DAA
58. The default value is NO This tag requires that the tag ENABLE_PREPROCESSING is set to YES SEARCH_INCLUDES Ifthe SEARCH_INCLUDES tag is set to YES the includes files in the INCLUDE_PATH will be searched if a include is found The default value is YES This tag requires that the tag ENABLE_PREPROCESSING is set to YES 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 This tag requires that the tag SEARCH_INCLUDES is set to YES 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 This tag requires that the tag ENABLE_PREPROCESSING is set to YES 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 e g 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 This tag requires that the tag ENABLE_PREPROCESSING is set to YES
59. 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 ina t xt 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 brackets after the code block Here is an example Generated by Doxygen 168 Special Commands code py class Python pass endcode code cpp class Cpp endcode See also section endcode and section verbatim 23 126 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 i
60. all test directories from a source tree for instance one could use EXCLUDE_PATTERNS test Doxygen looks at the file s extension to determine how to parse a file using the following table Extension Language idl IDL ddl IDL odl IDL java Java cs CH Generated by Doxygen 3 3 Step 2 Running doxygen 15 d 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
61. anchor 160 arg 166 attention 150 author 150 authors 150 b 167 prief 150 bug 151 c 167 callergraph 137 callgraph 137 category 138 cite 160 class 138 code 167 cond 151 copybrief 168 copydetails 168 copydoc 168 copyright 152 date 152 def 138 defgroup 139 deprecated 152 details 152 diafile 170 dir 139 docbookonly 168 dontinclude 163 dot 169 dotfile 170 e 170 else 152 elseif 152 em 171 endcode 171 endcond 153 enddocbookonly 171 enddot 171 endhtmlonly 172 endif 153 endinternal 140 endlatexonly 172 endlink 160 endmanonly 172 endmsc 171 endparblock 156 endrtfonly 172 endsecreflist 161 endverbatim 172 endxmlonly 172 enum 139 example 139 exception 153 extends 140 f 173 ML 173 f 173 f 173 f 173 file 140 fn 141 headerfile 142 hideinitializer 142 htmlinclude 166 ntmlonly 173 idlexcept 142 if 153 ifnot 154 image 174 implements 142 include 164 includelineno 164 ingroup 143 interface 143 internal 143 invariant 154 latexinclude 166 latexonly 174 Mi 175 line 164 210 INDEX link 160 mainpage 143 manonly 175 memberof 144 msc 169 mscfile 170 n 175 name 144 namespace 144 nosubgrouping 144 note 154 overload 144 p 175 package 145 page 145 par 155 paragraph 163 param 1
62. asses ek a a ee RA E a 413 Comment blocks in VHDL ss kie e ese a ee E RG ee eA a Ge ew a on N 10 10 11 13 14 14 15 15 16 16 16 16 16 17 CONTENTS 4 1 4 Comment blocks in Fortran 4 1 5 Comment blocks in Tcl 4 2 Anatomy of a comment block 5 Markdown 5 1 Standard Markdown 3 1 1 3 1 8 5 1 3 5 1 4 Sales 5 1 6 5 1 7 5 1 8 5 1 9 5 1 10 30 11 52 Markdown Extensions 201 5 2 2 523 5 2 4 5a Doxygen specifics 5 3 1 3 2 5 3 3 5 3 4 5 3 5 5 3 6 Dot 5 3 8 5 4 Debugging of problems 6 Lists 7 Grouping 7 1 Modules 7 2 Member Groups 7 3 Subpaging Paragraphs o ec cc bee ke res Headers is ae Ee ee o a oe Ges Block quotes 220 USGS p bow kode wee dee e ek ae Code Blocks 2 esha batt de haw eee Horizontal Rulers EMONASIS 1 Don oi ae ae Soe 8 oe a A COCR SHAMS cece a a Bee aca Ae ae Sek Mies bok Sd he Oe A 5 1 9 1 Inline Links 5 1 9 2 Reference Links WAGES o conta tank gon m ak de Automatic Linking Table of Contents Tables aoei ae ee he a Fenced Code Blocks Header Id Attributes Including Markdown files as pages Treatment of HTML blocks Code Block Indentation Emphasis MHS c ek ge a Re ee a Code Spans Limits Lists Extensions 0 Use of asterisks Limits on markup scope Generated by Doxygen CONTENTS IIl 8 Including Formulas 49 9 Graphs and diagrams 51 10 Preprocessing 55 11 Automatic
63. build of section labels round brackets 8 8 AND OR and NOT If you use an expression you need to wrap it in round brackets i e Acond LABEL1 amp amp LABEL2 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 x An interface x class Intf public x A method x virtual void func 0 cond TEST x A method used for testing virtual void test 0 Rendcond cond DEV The implementation of the interface class Implementation public Intf public void func cond TEST void test endcond cond xx This method is obsolete and does not show up in the documentation Generated by Doxygen 152 Special Commands void obsolete endcond endcond The output will be different depending on whether or not ENABLED_SECTIONS contains TEST or DEV See also sections endcond and ENABLED_SECTIONS 23 58 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 23 59 date date description Starts a paragr
64. 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 The second part forms a reference manual e Section Features presents an overview of what doxygen can do e Section Doxygen usage shows how to use the doxygen program e Section Doxywizard usage shows how to use the doxywizard program 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 CH style XML commands that can be used within the 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 2014 by Dimitri van Heesch Permission to use copy modify a
65. change english into the name of your language use lower case char acters only Depending on the language you may also wish to change the member functions Latex LanguageSupportCommand and other you will recognize them when you start the work Edit all the strings that are returned by the member functions that start with t r Try to match punctuation and capitals To enter special characters with accents you can Enter them directly if your keyboard supports that Recall that the text is expected to be saved using the UTF 8 encoding Doxygen will translate the characters to proper IATEX and leaves the HTML and man output in UTF 8 Use HTML codes like amp aum1 for an a with an umlaut i e 4 See the HTML specification for the codes On nix systems Rerun the configure script from the root i e in the doxygen directory so that it generates doxygen src lang_cfg h This file should now contain a define for your language code Run make again from the root i e in the doxygen directory of the distribution in order to regenerate the Makefiles On Windows stop Visual Stdio open a command window goto the directory doxygen srce give the command python languages py gt winbuild Languages rules close the command window start Visual Studio again Your language should now be selectable in the General part of the Settings of the Properties window of lang_cfg py by default Your la
66. coca ic ewe es 22 8 ENUM_VALUES PER LINE 22 8 HTML_INDEX_NUM_ENTRIES 22 8 EXAMPLE PATH ooo be ba Oe ey aed 22 5 HTML OUTPUT se oes ees sido da eos 22 8 EXAMPLE_PATTERNS 00000005 22 5 HTML STYLESHEET oo ooo ee ee es 22 8 EXAMPLE_RECURSIVE 204 22 5 HTML_TIMESTAMP o ooo ees 22 8 0 e che BS Ge eee ed 22 5 IDL_PROPERTY_SUPPORT 22 2 EXCLUDE PATTERNS oo capaci sacada 22 5 IGNORE_PREFIX ooo ooo ee 22 7 EXCLUDE SYMBOLS 2 66 cee eee 22 5 IMAGE PATH ooo 2 46 E 22 5 EXCLUDE SYMLINKS 2 4 4 suprot saca 22 5 INCLUDED_BY_GRAPH 22 18 EXPAND_AS DEFINED oco cc 6 06 ese 22 16 INCLUDE FILE PATTERNS 22 16 EXPAND_ONLY PREDEF co 0 22 16 INCLUDE GRAPH ooo cemi eee eee es 22 18 EXTENSION_MAPPING 05 22 2 INCLUDE PATH occiso oie be eee 22 16 EXTERNAL GROUPS occi srce eina nicemu 22 17 INHERIT DOCS oi ici ee 22 2 EXTERNAL PAGES ooo aanu 0 2 hd 44a waa a 22 17 INLINE_GROUPED_CLASSES 22 2 EXTERNAL SEARCH 2 0 6 00 ca eae 22 8 NUNE NFO afi ves kk ee hee ge kg we aw dealt 22 3 EXTERNAL_SEARCH_ID 22 8 INLINE_INHERITED_MEMB 222 EXTRACT ALL occiso td eaten sa 22 3 INLINE_SIMPLE_STRUCTS 22 2 EXTRACT_ANON_NSPACES 22 3 INLINE SOURCES io cs ee ee m ss 22 6 EXTRACT LOCAL GLASSES 20 aes 22 3 IMM ess coos a dog o ated oe a oi goa aig w de ha de pel 2
67. comment as the brief description If set to NO the Qt style will behave just like regular Qt style comments thus requiring an explicit brief command for a brief description The default value is NO 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 The default value is NO INHERIT_DOCS If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the docu mentation from any documented member that it re implements S GI The default value is Y 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 The default value is NO 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 Minimum value 1 maximum value 16 default value 4 ALIASES This tag can be used to spe
68. 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 17 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 A A A A 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 instruct 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 Ple
69. cus Sass ee Sa a ER Go hae A a 23 114 NSHODIIIG foe ce ea i we ee eR Ge ate Wa 23 115 MPI iste as eae laos cot ot de he es eg estas dn ake Hate Bt ge 23 116 ISO bolas aa a Bee a me we we 23 46 NSUIDP AGE bk a he ee a a E 23 104 AOE GOIO via aa e hE ee sa Aes God 23 4107 SUDSUDSECI N aora ro rae p i pa a GO eee aa 23 108 iableofcontents o ai e ee 23 105 MEIL o aee hte a on a Se A Bie ca 23 88 WOW ii a EL hada oe ehh eee 23 89 IOWA ais Se hed oe we le a eS 23 90 NOOO Lick BASS Bde amp eee ee ee Seek S 23 91 MSI o Sandan Si So Beet hae aaa Ee 23 75 MOREE 2 oe Sih ok sai ee Se ee amp mee EA a ea Se ee 23 47 o oo ea Se ee oe He Cod BE Se ES 23 48 UN as oo Ge co ras we Se eee ean ee ri 23 117 Walla dra ras di Rad e i A 23 49 WO os ceo a a Re a a ci 23 160 WOrbinGhide x cos oe bk ee ee 40 max a 23 118 ORIO i ok a a Hh ee dee y OE wR A 23 92 WIN os Giga GG 8 eS ale Bis ROSS wale oF 4 23 50 o eee oe e ES ewe ee a dea ae 23 93 AEROBIC e eee ed a ae 23 51 a ua Se Se ee RA we ch t a ale i ete 23 161 EOI oc e aE a eee t a 23 94 A A A oh a 23 166 MO ek ky ee AA a Bok ede ee AA ATR 23 163 Viste he Oe AAA ROR Ee Cee BS 23 162 e AA ee MOE ee ee OS Cae Ree ee 23 165 Ps PRE ot BM oe OES AA ee OE e ed 23 164 Me cong be ee Rak love Holle ts bo ee 23 168 WP te oe a Aas it aod a ORAS ew Koha SF 23 169 RE ih oe ee Ee Be hoe A ee 23 167 o a A OUR ts BO a be Oe es A 23 170 WP an ae a Rada a a a A DA acs 23 171 A SY she te Poa se Dan od Se c
70. 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 delegated 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 popGeneratore 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 s
71. 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 74 Customizing the Output e DISABLE_INDEX NO e GENERATE_TREEVIEW YES 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 GENERATE_TREEVIEW NO 14 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 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 14 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
72. ea ae TEMPLATE_RELATIONS o 22 18 UE oe Ae ee A deeb GG Boas 2 aoe 22 4 TOC EXPAND ooa a oa ec ee da bee 22 8 RECURSIVE o oore naptar aE G pi Ra 22 5 REFERENCED BY RELATION 22 6 TRERVIEW WIETH so o ei a he a ea e REFERENCES LINK SOURCE 206 TYPEDEF HIDES STRUCT 22 2 REFERENCES RELATION 22 6 UML_LIMIT NUM_FIELDS 2 0 eee 22 18 REPEAT BRIEF o o oka shad AS aan 22 2 UML_LOOK coco 22 18 RTF_EXTENSIONS FILE oo o 22 10 USELHTAGS ooo 22 6 RTF_LHYPERLINKS o 22 10 USE_MATHJAX ooo 22 8 RTF OUTPUT oiaue panood Oa he oe ee 22 10 USE _MDFILE_AS MAINPAGE 22 5 RTF_STYLESHEET FILE 0 22 10 USE_PDFLATEX 0 00 22 9 SEARCHDATA FILE Ae ge Bae tee da eee a 22 8 VERBATIM_HEADERS 6 2c eee bee eee es 22 6 SEARCHENGINE 000 22 8 WARNINGS s ca bk aie ao ai poin kana inia E 22 4 SEARCHENGINE URL 22 8 WARNLFORMAT s eiii o aanre a ee og 22 4 SEARCH_INCLUDES 22 16 WARNLIF_DOC_ERROR 02 6 cee Ge pee es 22 4 SEPARATE_MEMBER_PAGES Soca a de fee Ae a Seuss a 22 2 WARN_IF_UNDOCUMENTED tite oe ike WS Soe ae Ne gs 22 4 SERVER BASED SEARCH 22 8 WARN LOGFILE 0000 22 4 SHORT NAMES 000e0ee 22 2 WARN_NO_PARAMDOC oouo oo 22 4 BHOW FILES oo dha Poet ee ba eas 22 3 XML OUTPUT ns has wh e ad eS 22 12 SHOW_GROUPED MEMB_INC 22 3
73. enums and defines JavaDoc 1 1 qdoc3 partially and ECMA 334 C spec compatible Comes with a GUI 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 Microsofts 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 condi
74. executable doxygen is the main program that parses the sources and generates the 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 custo F output rea i generate edit XML files al doxmlparser lib R Config file 7 Layout file Doxyfile N make ps postscript e w m generate generate Latex files latex read upd gt pdate e Makefile make pdf PDF read Lr Sources j Doxygen i pp read read generate Custom e Man pages headers LH footer Tag file s A eee images J Windows only _ import doc refman rtf T MS Word m i HTML read cun i pages gt HTML Help Workshop gt Fig
75. for phoDocumentor i e param datatypel datatype2 Sparamname description 23 73 parblock For commands that expect a single paragraph as argument such as par param and warning the parblock command allows to start a description that covers multiple paragraphs which then ends with endparblock Example x Example of a param command with a description consisting of two paragraphs x param p parblock First paragraph of the param description Second paragraph of the param description endparblock Rest of the comment block continues A XA A A F Note that the parblock command may also appear directly after param s first argument 23 74 endparblock This ends a block of paragraphs started with parblock 23 75 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 23 76 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 po
76. he Swe Lae woe Se So 23 10 ME EN 23 7 NOMI Randy a Got he Gow ae ae Lk Aa ee eed 23 11 a oes ce ae E Gee BY a 23 8 RENTO oie i oS ee A ed 23 66 doprecated oc ei ore ae Se ae ee mw 23 60 E o oo a ee Re a a we ee A a aa 23 13 AS coo a ae IS ta Ar ad a AS POR ds Meee 23 61 IS en eal EN ae ara a Sg ae a taal 23 147 ROAR eS ty son Give acca te hee Pods Me Ga Bay he Se Pa Pe 23 134 Y aco a Rs eee a ae D 23 148 RUM a Se Rie See e tho wae eee ae e a 23 9 Y a Ae ee ee he OR Ge ee eee E a 23 149 paa ne ek odds Bae ed Baa a 23 129 Ma DAS G3 Hea Ss Ye See ed 23 150 Special Commands Moddare 6h ODA OE a e lew wet me Wideinitigiizer o bocca ia eee we WIMINCIUAS sa kh ron eR a 23 119 AA a de ee ee a 23 152 MUS chads o Sica bance A ae ee Moa pza SA oe Ge ae es eed E Gana aed a NOE sa Bh ae al ode Se ei MADE ae ee be ee hal he a eo a a 23 153 Vimplements 0 ce a a a PONGE lt a ae a 23 111 includelineno o 00020000 23 112 MONA 25 2 0 are a fous ak spa WOME 2 66 oa e a RS MVR 6 4 be RE AA o AR MASOIE cora ee ee Am a 23 120 MELO io ch bts he aap hls dk ees ad a 23 154 O AER Seah a a Fed we oh eh uo ee 23 156 AS a a o amp Gua Bons A AA a ee h A ee he PEAS we eR a ER 23 155 uc a e a e e aa a a ew A 23 131 WEE 8 ass RI Bra Se ee Ha 23 133 Woa ao p gor aa Aani i ie A 23 157 MAME ai A A a BS ae BOR o a MAMESPADE os ccp a rase a ea Ea e aa WNOSUDQIOUDING lt ea aci ee a a a AE E o A
77. 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 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 7 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 a 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 then create the com yourcompany yourproject directory so with the same name as the value of ECLI PSE_DOC_ID inthe plugin directory of eclipse and after doxygen completes copy to contents of the help output directory to the com yourcompany yourproject directory Then re
78. in the configuration file The section label can be a logical expression build of section names round brackets amp amp AND OR and NOT If you use an expression you need to wrap it in round brackets ie Acond LABEL1 amp amp LABEL2 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 if Cond3 Only included if Cond2 and Cond3 are set endif More text endif Unconditional text 4 4 F FF FF HF FH HF HF Generated by Doxygen 154 Special Commands You can also use conditional commands inside aliases To document a class in two languages you could for instance use Example 2 Nenglish This is English endenglish dutch x Dit is Nederlands enddutch class Example y Where the following aliases are defined in the configuration file ALIASES english 1if english endenglish endif dutch if dutch enddutch endif and ENABLED_SECTIONS can be used to enable either english or dutch See also sections endif ifnot else elseif and ENABLED_SECTIONS 23 68 ifnot section label Starts a conditional documentation section The section ends with a matching endif command This conditional section is enabled by default To disable i
79. 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 15 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 80 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 See l SomeClass Some Text for more information inside the comment block and it will expand to x See ref SomeClass Some Text for more information x 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 intermed
80. kral at gmail dot com Portuguese Rui Godinho Lopes resigned rgl at ruilopes dot com 1 8 0 Fabio FJTC Jun Takada Chino jun chino at uol dot com dot br Romanian lonut Dumitrascu reddumy at yahoo dot com almost up to date Alexandru losup aiosup at yahoo dot com Russian Brilliantov Kirill Vladimirovich brilliantov at byterg dot ru almost up to date Alexandr Chelpanov cav at cryptopro dot ru Serbian Dejan Milosavljevic unreachable dmilos at email dot com 1 6 0 SerbianCyrillic Nedeljko Stefanovic stenedjo at yahoo dot com 1 6 0 Slovak Kali Laco Svec the Slovak language advisors up to date Petr P ikryl prikryl at atlas dot cz Slovene Matja Ostrover nik matjaz dot ostroversnik at ostri dot org 1 4 6 Spanish Bartomeu bartomeu at loteria3cornella dot com up to date Francisco Oltra Thennet unreachable foltra at puc dot cl David Vaquero david at grupoikusnet dot com Swedish Bj rn Palmqvist bjorn palmqvist at aidium se almost up to date Turkish Emin Ilker Cetinbas niw3 at yahoo dot com 175 Ukrainian Olexij Tkatchenko resigned olexij at tkatchenko dot com 1 8 4 Petro Yermolenko python at i dot ua Vietnamese Dang Minh Tuan tuanvietkey at gmail dot com 1 6 0 Most people on the list have indicated that they were also 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 Th
81. link generation 59 11 1 Links to web pages and mail addresses ee et 59 112 MSIE CASES cos ca a eee he a O AA a 59 Mes ISA 0 a as Bee ER AR A a EE w aa 59 TLA Links TO TURCUIONS oi raros a a a dees 59 11 8 Links da OMeSFMem8berS 2 252 502 0622 dd A a id e ie hes 60 Vi pedel os cr a A wa le Gea A a A e a 62 12 Output Formats 63 13 Searching 65 13 1 External Indexing and Searching o e 67 T2004 MOON ARRE A Ee eS gen aes 67 WS COMING o ce0 eae ee ra we eG ee Re a AE TR 68 WALZA Single project NGes sone ss t ak Sek eR ee aod ae ae a em a 69 13122 Muhi project ingek io eh eee SEE PRE RED a 69 118 Updating iieindex 2 4 64 46 84 Be ba ee ee ee ER Ree ee ee ee 70 131 4 Programming wera csi 2 aeos gb ke ae he oe a ee A a a O a 70 13 1 4 1 Indexer inputformat se cac ee ee 70 13 1 4 2 Search URL format 0 00 e 71 13 1 43 Search results format 2 2 ca eoe ea ee ee 71 14 Customizing the Output 73 14 1 Minot TWeakS os ha ee Sov ee ae ee a Se ae ee ae pe eee a 73 141 1 Overal Colg 2 we ae he a era a BE Ree A oe we Sh ee A 73 AGA NAGO 6 8 23 8 ee aw ed Be ee a Pee Be bi bee 73 MA Dinamie COAST oc a ss Roe aoe ec ee ae Ba ea A eee i le 74 14 1 4 Header Footer and Stylesheet changes 2 000002 eee eae 74 14 2 Changing the layout of pages a 75 143 Using ive AVILGU BUE cie a Ee Be ph a ee A A a a a 78 15 Custom Commands 79 iSt is E 0 ore cy a Ree ee R
82. lost at cyberspace Indonesian Hendy Irawan ceefour at gauldong dot net 1 8 0 Italian Alessandro Falappa alessandro at falappa dot net 1 8 2 Ahmed Aldo Faisal aaf23 at cam dot ac dot uk Japanese Suzumizaki Kimikata szmml at h12u com up to date Hiroki Iseri goyoki at gmail dot com 204 Internationalization Ryunosuke Satoh sun594 at hotmail dot com Kenji Nagamatsu unreachable naga at joyful dot club dot ne dot jp Iwasa Kazmi unreachable iwasa at cosmo system dot 3p JapaneseEn see the Japanese language English based Korean Kim Taedong fly1004 at gmail dot com up to date SooYoung Jung jung5000 at gmail dot com Richard Kim unreachable ryk at dspwiz dot com KoreanEn see the Korean language English based Latvian Lauris lauris at nix lv 1 8 4 Lithuanian Tomas Simonaitis unreachable haden at homelan dot 1t 1 4 6 Mindaugas Radzius unreachable mindaugasradzius at takas dot lt Aidas Berukstis unreachable aidasber at takas dot lt 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 Jordet 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 8 2 Grzegorz Kowal unreachable g_kowal at poczta dot onet dot pl Krzysztof Kral krzysztof dot
83. marked as almost up to date 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 class 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 translatore _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 Generated by Doxygen 208 Internationalization 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 a 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 in
84. name If set to NO the members will appear in declaration order Gl The default value is YES 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 members will appear in declaration order Note that this will also influence the order of the classes in the class list The default value is NO SORT_MEMBERS CTORS_1ST If the 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 constructors will appear in the respective orders defined by SORT_BRIEF_DOCS and SO RT_MEMBER_DOCS Note If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief member documentation If SORT_MEMBER_DOGS is set to NO this option is ignored for sorting detailed member documentation The default value is NO SORT_GROUP_NAMES f 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 group names will appear in their defined order The default value is NO 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 to NO the class list will be sorted only by class name
85. 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 of bold text lt STRONG gt Ends a section of bold text lt SUB gt Starts a piece of text displayed in subscript Generated by Doxygen 183 e lt SUB gt Ends a lt SUB
86. 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 23 18 idlexcept lt name gt Indicates that a comment block contains documentation for a IDL exception with name lt name gt 23 19 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 Generated by Doxygen 23 20 ingroup lt groupname gt lt groupname gt lt groupname gt 143 See also section extends and section memberof 23 20 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 23 21 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 23 22 internal This command starts a documentation fr
87. raw search data e doxyindexer indexes the data into a search database doxysearch db when a user performs a search from a doxygen generated HTML page the CGI binary doxysearch cgi will be invoked e the doxysearch cqgi tool will perform a query on the database and return the results The browser will show the search results 13 1 2 Configuring The first step is to make the search engine available via a web server If you use doxysearch cgi this means making the CGI binary available from the web server i e be able to run it from a browser via an URL starting with http How to setup a web server is outside the scope of this document but if you for instance have Apache installed you could simply copy the doxysearch cgi file from doxygen s bin dir to the cgi bin of the Apache web server Read the apache documentation for details To test if doxysearch cgi is accessible start your web browser and point to URL to the binary and add test at the end http yoursite com path to cgi doxysearch cgi test You should get the following message Test failed cannot find search index doxysearch db If you use Internet Explorer you may be prompted to download a file which will then contain this message Since we didn t create or install a doxysearch db it is ok for the test to fail for this reason How to correct this is discussed in the next section Generated by Doxygen 13 1 External Indexing and Searching 69
88. see the image commana 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 Doxygen will then use the output that the filter program writes to standard output If FILTER_PATTERNS is specified this tag will be ignored Note that the filter must not add or remove lines it is applied before the code is scanned but not when the output code is generated If lines are added or removed the anchors will not be placed correctly FILTER_PATTERNS The FILTER_PATTERNS 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 information on how filters are used If the FILTER_PATTERNS tag 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 INe PUT_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 The default valu
89. shown above To refer to a markdown page without such label you can simple use the file name of the page e g See the other page other md for more info 5 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 5 3 3 Code Block Indentation Markdown allows both a single tab or 4 spaces to start a code block Since doxygen already replaces tabs by spaces before doing Markdown processing the effect will only be same if TAB_SIZE in the config file has been set to 4 When it is set to a higher value spaces will be present in the code block A lower value will prevent a single tab to be interpreted as the start of a code block With Markdown any block that is indented by 4 spaces and 8 spaces inside lists is treated as a code block This indentation amount is absolute i e counting fr
90. some other sectioning command is encountered 23 53 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 aut hor command may mention several authors The aut hor command ends when a blank line or some other sectioning command is encountered Example Ir brief Pretty nice class details This class is used to demonstrate a number of section commands x author John Doe x author Jan Doe x version 4 la x date 1990 2011 x pre First initialize the system bug Not all memory is freed when deleting an object of this class x warning Improper use can crash your application copyright GNU Public License class SomeNiceClass 23 54 authors list of authors Equivalent to author 23 55 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 Generated by Doxygen 23 56 bug bug description 151 declaration of the member and prepended to the detailed description
91. specify one or more MathJax ex tension names that should be enabled during MathJax rendering For example MATHJAX_EXTENSIONS TeX AMSmath TeX AMSsymbols This tag requires that the tag USE_MATHJAX is set to YES MATHJAX_CODEFILE The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces of code that will be used on startup of the MathJax code See the MathJax site for more details As an example to disable the Math Renderer menu item in the Math Settings menu of MathJax MATHJAX_CODEFILE disableRenderer js with in the file disableRenderer js MathJax Hub Config menuSettings showRenderer false This tag requires that the tag USE_MATHJAX is set to YES 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 lt access key gt S what the lt access key gt is depends on the OS and browser but it is typically lt CTRL gt lt ALT gt
92. such a list can be seen at the top of the page 23 102 secreflist Starts an index list of item created with refitem that each link to a named section 23 103 endsecreflist End an index list started with secreflist 23 104 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 and 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 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 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 sectio
93. 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 but currently Qt 5 x is not supported This is needed to build the GUI front end doxywizard A ATEX distribution for instance TeX Live This is needed for generating IATEX Postscript and PDF output 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 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 e 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 Inst
94. the XML file it is recommended to use a SAX based parser to process it 13 1 4 2 Search URL format When the search engine is invoked from a doxygen generated HTML page a number of parameters are passed to viathe query string The following fields are passed q the query text as entered by the user n the number of search results requested p the number of search page for which to return the results Each page has n values cb the name of the callback function used for JSON with padding see the next section From the complete list of search results the range nxp nx p 1 1 should be returned Here is an example of how a query looks like http yoursite com path to cgi doxysearch cgi q list amp n 20 amp p 1 amp cb dummy It represents a query for the word list q list requesting 20 search results n 20 starting with the result number 20 p 1 and using callback dummy cb dummy Note The values are URL encoded so they have to be decoded before they can be used 13 1 4 3 Search results format When invoking the search engine as shown in the previous subsection it should reply with the results The format of the reply is JSON with padding which is basically a javascript struct wrapped in a function call The name of function should be the name of the callback as passed with the cb field in the query With the example query as shown the previous subsection the main structure of the reply should l
95. the dot generated graphs The default value is YES This tag requires that the tag HAVE_DOT is set to Y Gl S DOT_CLEANUP If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot files that are used to generate the various graphs The default value is YES This tag requires that the tag HAVE_DOT is set to Y E un 22 19 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 Generated by Doxygen 22 19 Examples 133 INPUT example cc example h Assuming the example makes use of Qt classes and per 1 is located in usr bin a more realistic configuration file would be PROJECT_NAME Example INPUT example cc example h WARNINGS YES TAGFILES qt 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 WARNINGS YES INPUT examples examples doc src FILE PATTERNS cc h INCLUDE_PATH examples TAGFILES qt 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 Q0t OUTPUT_DIRECTORY gt_docs HIDE_UNDOC_MEMBERS YES HIDE_UNDOC_CLASSES YES
96. 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 QImage image 64 64 QImage Format_RGB32 image fill qRgb 255 160 128 Adding a resource document gt addResource OTextDocument ImageResource QUrl mydata image png QVariant 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 23 117 1 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 Generated by Doxygen 166 Special Commands 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 23 118 verbinclude lt file name gt This command includes the file
97. to configure and run doxygen The first step is to choose one of the ways to configure doxygen 96 Doxywizard usage 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 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
98. use STRIP_FROM_INC_PATH to strip a user defined part of a path You can also document your class as follows class MyClassName include h path include h Docs for MyClassName 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 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 index chm for project b into b chm In the configuration file for project a you write TAGFILES b 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
99. used as the annotated text Otherwise the brief description is used as is If left blank the following values are used Sname is automatically re placed with the name of the entity The Sname class The Sname widget The Sname fil is provides specifies contains represents a anand the ALWAYS_DETAILED_SEC lfthe 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 E u The default value is NO 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 The default value is NO FULL PATH_NAMES If 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 unique will be used The default value is Y E n Generated by Doxygen 22 2 Project related configuration options 105 STRIP_FROM_ PATH The STRIP_FROM_PATH tag can be used to strip a user defined part of the path Strip ping 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
100. value 240 default value 80 This tag requires that the tag GENERATE_HTML is set to Y GI S 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 The default value is YES This tag requires that the tag GENERATE_HTML is set to YES 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 The default value is NO This tag requires that the tag GENERATE_HTML is set to Y E Ss HTML_INDEX_NUM_ENTRIES With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries shown in the various tree structured indices initially the user can expand and collapse entries dynam ically later on Doxygen will expand the tree to such a level that at most the specified number of entries are visible unless a fully collapsed tree already exceeds this amount So setting the number of entries 1 will produce a full collapsed tree by default 0 is a special value representing an infinite number of entries and will result in a full expanded tree by default Minimum value 0 maximum value 9999 default value 100 This tag requires that the tag GENERATE_HTML is set to YES GENERATE_DOCSET If t
101. was for a member without any explicit documentation The following example puts VarInA into group A and silently resolves the conflict for IntegerVariable by putting it into 44 Grouping group IntVariables because the second instance of IntegerVariable is undocumented kx x ingroup A extern int VarInA TRE defgroup IntVariables Global integer variables x x x x an integer variable extern int IntegerVariable xx x xx defgroup Variables Global variables xx gt xx a variable in group A x int VarInA int IntegerVariable xx 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 defgroup groupl The First Group This is the first group xx brief class Cl in group 1 class Cl brief class C2 in group
102. 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 GVall x 1 lt global enum value 1 x Generated by Doxygen Automatic link generation 62 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 11 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 x A coordinate pair struct CoordStruct 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 This function returns the addit
103. ws A Mine ad tsa woe Ne dee Pee ce age S cea a ee ek AAS 23 158 Package egos oe es i Set Ge ke wn ee A a ee eo MOBS a arrar aoe he ek Mant OH Ghd amp Donna sd aon amp MOOS Sah igi csc oat a tarts al ADA paragraph i oe s ie ae a Be ae es ee 23 109 o 223 ache he oad St De ie aoe Be aE Ss Soe te Sb nt A a A o o a hc i a a a A e E A E A D ai e OB ook aiak Boa eh ke a ke me Ai DE cA ls ee Raw a ee kk a a te MOYO a ada Ate Gi ak Sa e Sew e cc eo ae ae ea Ge ee ae aa MDODO ic oe PRS Pa ee MONOIOGIER o i Sie a ee ek wn Ae ae ee protectedsection o a A ee eee de ek ea a a NOUNS eee ie aed BSc i Stee ee Aa e BG noe ea MBUBIIGSOGHON ocio eee Ee a a e oia DU ico ia a o a A A WI A ah Pe E ns a 23 100 MOT N oko a Oe ew BA a ie Be ls 8 23 101 VANO Lt Bec AOE aha Ge A a a WOES E WElAIGdaISG ne a ae a 23 43 WEIAIGSAISO o a ewe a ae ai ee 23 42 GON oor sie a RS le FES cis Re e E 23 78 WOKS cs Be cs Re SES 23 79 WO i ae eek cae ha HA ed ee we od amp oR we a 23 80 MO A A A 23 81 o 2 6 oe 24 ae a RAS bee Ree Li 23 82 WWA ua a a i ee ss A 23 83 AU a a a a ah Ta Nise apa eh Sead 23 159 PE a eye oe do tokyo AA 23 84 o 4 ok bk bee we See eee ee PR we we 23 102 SOCIO Aa Oe AR oe Pee ee 23 106 MOORS o a oes Be a hae Ad aS 23 85 GAO iti ke ee BY eS ee A 23 86 ASPOWINIRGNzZSF i lt lt lt lt lt ss 23 44 WINGS 626 aa Sa cb SU SSE SADDER ew RE RSS 23 87 IERD ck serosa
104. 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 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 brief 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 4 1 Special comment blocks 21 Brief description which ends at this dot Details follow here 3 A third option
105. 1l 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 x2 x1 92 y1 2 Unnumbered displayed formulas that are centered on a separate line These formulas should be put between M and f commands An example NET 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 f results in ai f won quan cars 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 TEX 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 f
106. 2 5 EXTRACT_LOCAL_METHODS 22 3 INPUT_ENGODING 2 0c cc ms 22 5 EXTRACT_PACKAGE io onoo ucence eniin 22 3 NEUT FILTER i ce caia keke ee ae be et 22 5 EXTRACT PRIVATE io nio 22 3 INTERACTIVE SVG 000 22 18 EXTRACT STATIG oos ia bi dle eka aa 22 3 INTERNAL DOOS 2 lke ia ee wt 22 3 EXTRA_PACKAGES 0 22 9 JAVADOC_AUTOBRIEF 22 2 EXTRA_SEARCH_MAPPINGS 22 8 LATEX BATOHMODE oo iio a whe we 22 9 EXT_LINKS IN WINDOW 22 8 LATEX BIB STYLE ooo ce ee ae a 22 9 PILE PATTERNS iu sia A dle eka a oo 22 5 LATEX GMD NAME le a e a 22 9 FILE_VERSION_FILTER aoaaa aaa 22 3 LATEX EXTRA FILES oo o coca ai annate mts 22 9 FILTER PATTERNS io oao ee ee 22 5 LATEX FOOTER o ita a a he we 22 9 FILTER_SOURCE_FILES 22 5 LATEX HEADER cocoa chek ee ea ee we te 22 9 FILTER_SOURCE_PATTERNS 22 5 LATEX HIDE INDICES o o oori se co 22 9 FORGE LOCAL INCLUDES oo io es 22 3 LATEX OUTPUT unc aot a ke ean ws 22 9 FORMULA FONTSIZE oe ee ee 22 8 L TEX SOURCE CODE p eo ee ee 22 9 FORMULA_TRANSPARENT 22 8 LAYOUT FLE ota lA eae te aes 22 3 FULL PATH_NAMES ooo coca 22 2 LOOKUP_CACHE SIZE p eosi eee 22 2 GENERATE_AUTOGEN_DEF 22 14 MACRO_EXPANSION oo sreco instaat aan 22 16 GENERATE_BUGLIST 0 0 ce ee 22 3 MAKEINDEX_CMD_NAME 22 9 GENERATE_GHI c ec a a ee a a 22 8 MAN_EXTENSION noop ce ee
107. 55 parblock 156 post 156 pre 156 private 146 privatesection 146 property 146 protected 146 protectedsection 147 protocol 147 public 147 publicsection 147 pure 147 ref 160 refitem 161 related 148 relatedalso 148 relates 148 relatesalso 148 remark 157 remarks 157 result 157 return 157 returns 157 retval 157 rtfonly 176 sa 157 secreflist 161 section 162 see 158 short 158 showinitializer 148 since 158 skip 164 skipline 165 snippet 165 static 149 struct 149 subpage 161 subsection 162 subsubsection 162 tableofcontents 162 test 158 throw 158 throws 158 todo 158 tparam 156 typedef 149 union 149 until 165 var 149 verbatim 176 verbinclude 166 version 158 Wvhdlflow 149 warning 159 xmlonly 176 xrefitem 159 ABBREVIATE_BRIEF 104 acknowledgments 5 ALIASES 105 ALLEXTERNALS 129 ALLOW_UNICODE_NAMES 104 ALPHABETICAL_INDEX 115 ALWAYS_DETAILED_SEC 104 AUTOLINK_SUPPORT 106 BINARY_TOC 119 bison 7 BRIEF_MEMBER_DESC 104 browser 15 BUILTIN _STL_SUPPORT 106 CALL_GRAPH 131 CALLER_GRAPH 131 CASE_SENSE_NAMES 109 CHM_FILE 119 CHM_INDEX_ENCODING 119 CITE_BIB_FILES 111 CLANG_ASSISTED_PARSING 114 CLANG_OPTIONS 114 CLASS_DIAGRAMS 129 CLASS_GRAPH 130 COLLABORATION_GRAPH 130 COLS_IN_ALPHA_INDEX 115 COMPACT_LATEX 123 COMPACT_RTF 125 CPP_CLI_SUPPORT 106 CREATE_SUBDIRS
108. 9 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 1ink and endlink commands serves as text for a link to the lt link object gt specified as the first argument of link See also Section autolink for more information on automatically generated links and valid link objects 23 100 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 Generated by Doxygen 23 101 refitem lt name gt 161 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 23 101 refitem lt name gt Just like the ref command this command creates a reference to a named section but this reference appears in a list that is started by secreflist and ends with endsecreflist An example of
109. AP DISP_FUNCTION class name function result id END_DISPATCH_MAP IMPLEMENT_OLECREATE2 class name idl id2 id3 id4 id5 id6 id7 id8 id9 idl0 idl1 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 doxygen d Preprocessor This will instruct doxygen to dump the input sources to standard output after preprocessing has been done Hint set QUI KT Y ES and WARNINGS NO in the configuration file to disable any other output Generated by Doxygen Chapter 11 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 IATEX 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 11 1 Links to web pages and m
110. D0O0BNRAO To get proper looking output you need to set OPTIMIZE_OUTPUT_VHDL to Y file brief 2 1 Mux using with select Use standard library library ieee Use logic elements use ieee std_logic_1164 allj 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 Second input sel in std_logic Select input mux_out out std_logic Mux output end entity brief Architecture 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 ES 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 Generated by Doxygen 28 Documenting the code 4 1 4 Comment blocks in Fortran GI When using doxygen for Fortran code you should set OPTIMIZE_FOR_FORTRAN to YES The parser tries to guess if the source code is fixed format Fortran or free format Fortran code This may not always be correct If not one should use EXTENSION_MAPPING to correct this By setting EXTENSTON_MAPPING f FortranFixed f90 FortranFree files with extension 90 are interpreted as fixed format Fortran c
111. Details follow Here is the same piece of code as shown above this time documented using the JavaDoc style and JAVADOC_ AUTOBRIEF set to YES rx A test class A more elaborate class description class Test public jee An enum More detailed enum description enum TEnum TVall lt enum value TVall x TVal2 lt enum value TVal2 x TVal3 lt enum value TVal3 xenumPtr lt enum pointer Details x enumVar lt enum variable Details x xx A constructor A more elaborate description of the constructor Test xx A destructor Generated by Doxygen 24 Documenting the code A more elaborate description of the destructor Test i 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 4 OF OF OH OF int testMe int a const char xs xx A pure virtual member see testMe param cl the first argument x param c2 the second argument virtual void testMeToo char cl char c2 0 xx a public variable Details int publicVar kx a function variable Details int handler int a int b Similarly if one wishes the first sentence of a Qt style documentation block to automatic
112. K 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 manageable 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 total amount of fields shown is limited to 10 Minimum value 0 maximum value 100 default val 15 fields may appear but if the number exceeds 15 the ue 10 This tag requires that the tag HAVE_DOT is set to YES If the T EMPLATE_RELATIO NS tag is set to YES then the inheritance and collabora tion graphs will show the relations between templates and their instances The default value is NO This tag requires that the tag HAVE_DOT is set to Y set to YES then doxygen will generate a graph for Gl S If the INCLUDE_GRAPH ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are each documented file showing the direct and indirect include dependencies of the file with other documented files GI The default value is YES This tag requires that the tag HAVE_DOT is set to Y E un Generated by Doxygen 22 18 Configuration options related to the dot tool 131 INCLUDED_BY_GRAPH If the INCLUDED_BY_GRAPH ENABLE_PREPROCESSING and SEARCH_INCLU gt
113. LATEX is set to YES PDF_HYPERLINKS lf the PDF_HYPERLINKS tag is set to YES the TEX that is generated is prepared for conversion to PDF using ps2pdf or pdf latex 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 The default value is YES This tag requires that the tag GENERATE_LATEX is set to YES USE_PDFLATEX Ifthe LATEX_PDF LATEX tag is set to YES doxygen will use pdf lat ex to generate the PDF file directly from the IAT X files Set this option to YES to get a higher quality PDF documentation Gl The default value is YES This tag requires that the tag GENERATE_LATEX is set to Y Gl S LATEX_BATCHMODE lf the LATEX_BATCHMODE tag is set to YES doxygen will add the batchmode com mand to the generated TEX 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 The default value is NO This tag requires that the tag GENERATE_LATEX is set to Y Fl n Generated by Doxygen 22 10 Configuration options related to the RTF output 125 LATEX_HIDE_INDICES If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the index chapters such as File Index Compound Index etc in the output The default value is NO
114. Module backend or the Perl Module based IATEX generator to the doxygen develop mailing list Suggestions are welcome as well 27 1 Usage When the GENERATE_PERLMOD tag is enabled in the Doxyfile running Doxygen generates a number of files in the per1mod 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 DoxyDocs pm you can use one of the default Perl Module based generators provided by Doxygen at the moment this includes the Perl Module based IATEX 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 lt want to use IATEX but not possible in headings gt 27 2 Using the LaTeX generator The Perl Module based IATEX ge
115. O the size of the Perl module output will be much smaller and Perl will parse it just the same The default value is YES This tag requires that the tag GENERATE_PERLMOD is set to YES PERLMOD_MAKEVAR_ PREFIX The names of the make variables in the generated doxyrules make file are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX This is useful so different doxyrules make files included by the same Makefile don t overwrite each other s variables This tag requires that the tag GENERATE_PERLMOD is set to YES 22 16 Configuration options related to the preprocessor ENABLE PREPROCESSING If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all C preprocessor directives found in the sources and include files The default value is YES MACRO_EXPANSION If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names in the source code If set to NO only conditional compilation will be performed Macro expansion can be done in a controlled way by setting EXPAND_ONLY_PREDEF to YES The default value is NO This tag requires that the tag ENABLE_PREPROCESSING is set to YES EXPAND ONLY _PREDEF If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then the macro expansion is limited to the macros specified with the PREDEFINED and EXPAND_AS_DE gt FINED tags Generated by Doxygen 128 Configuration
116. P 4 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 23 32 privatesection Starting a section of private members in a way similar to the private class marker in C Indicates that the member documented by 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 23 33 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 Mn typedef and War See also sections fn typedef and War 23 34 protected Indicates that the member documented by the comment block is protected 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 protect edsection Generated by Doxygen 23 35 protectedsection 147 See also sections memberof public private and protectedsection 23 35 protecteds
117. SOURCE_BROWSER tag to YES It can also include the sources directly into the documentation by setting INLINE SOURCES to YES this can be handy for code reviews for instance 3 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 man and or docbook directories inside the output directory As the names suggest these directories contain the generated documentation in HTML RTF ATEX XML Unix Man page and DocBook 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 MAN_OUTPUT and DOCBOOK_OUTPUT 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 3 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
118. SUCE ca aca Baw Oe a Rk Re Ge alle a ee Al lw aw Aaa ROR Aw Re we RE fe 201 28 Internationalization 203 Generated by Doxygen Part User Manual Chapter 1 Introduction Introduction Doxygen is the de facto standard tool for generating documentation from annotated C sources but it also supports other popular programming languages such as C Objective C C PHP Java Python IDL Corba Microsoft and UNO OpenOffice flavors Fortran VHDL Tcl and to some extent D Doxygen 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 IATEX 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 documentation consistent with the source code 2 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 Doxygen 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 the doxygen user manual and web site Doxygen is developed under Mac OS X and
119. T ET is set to Y an be used to turn on off the messages that are generated to standard output by doxygen ES this implies that the messages are off The default value is NO WARNINGS The WARNINGS tag can be used to turn on off the warning messages that are generated to standard error stderr by doxygen If WARNINGS is set to YES this implies that the warnings are on Tip Turn warnings on while writing the documentation The default value is YES WARN_IF_UNDOCUMENTED lf the WARN_IF_UNDOCUMENTED tag 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 The default value is YES WARN_IF_DOC_ERROR potential 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 If the WARN_IF_DOC_ERROR tag is set to YES doxygen will generate warnings for The default value is YES 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 doxygen will only warn about wrong or incomplete parameter documentation but not about the absence of documentation The default value is NO Generated by Doxygen 112 Configuration WARN_FORMAT The WARN_FORMAT t
120. TML commands otilde gouml divide goslash amp ugrave suacute amp ucirc amp uuml amp yacute amp thorn amp yuml amp fnof amp Alpha amp Beta amp Gamma amp amp Delta Epsilon amp Zeta amp Eta amp Theta amp Iota amp Kappa amp Lambda amp Mu amp Nu amp Xi amp Omicron amp Pi amp Rho amp Sigma amp Tau amp Upsilon amp Phi amp Chi amp Psi amp Omega latin small letter o with tilde 6 latin small letter o with diaeresis 6 division sign latin small letter o with stroke latin small letter o slash latin small letter u with grave latin small letter u with acute latin small letter u with circumflex latin small letter u with diaeresis U latin small letter y with acute y latin small letter thorn p latin small letter y with diaeresis y latin small f with hook function florin f greek capital letter alpha A greek capital letter beta B greek capital letter gamma T greek capital letter delta A greek capital letter epsilon E greek capital letter zeta Z greek capital letter eta H greek capital letter theta O greek capital letter iota greek capital letter kappa K greek capital letter lambda A greek capital letter mu M greek capital letter nu N greek capital letter xi greek capital letter omicron O g
121. TML output directory e g use Srelpath doxygen css to refer to the standard style sheet 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 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_TREEVI EW 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 c
122. 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 82 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 directory 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
123. UGLIST 110 GENERATE_CHI 119 GENERATE_DEPRECATEDLIST 110 GENERATE_DOCBOOK 126 GENERATE_DOCSET 118 GENERATE_ECLIPSEHELP 120 GENERATE_HTML 115 GENERATE_HTMLHELP 119 GENERATE_LATEX 123 GENERATE_LEGEND 132 GENERATE_MAN 126 GENERATE_PERLMOD 127 GENERATE_QHP 119 GENERATE_RTF 125 GENERATE_TAGFILE 129 GENERATE_TESTLIST 110 GENERATE_TODOLIST 110 GENERATE_TREEVIEW 120 GENERATE_XML 126 GPL 4 GRAPHICAL_HIERARCHY 131 GROUP_GRAPHS 130 HAVE_DOT 129 HHC_LOCATION 119 HIDE_FRIEND_COMPOUNDS 108 HIDE_IN_BODY_DOCS 108 HIDE_SCOPE_NAMES 109 HIDE_UNDOC_CLASSES 108 HIDE_UNDOC_MEMBERS 108 HIDE_UNDOC_RELATIONS 129 HTML_COLORSTYLE_GAMMA 118 HTML_COLORSTYLE_HUE 117 HTML_COLORSTYLE_SAT 117 HTML_DYNAMIC_SECTIONS 118 HTML_EXTRA_FILES 117 HTML_EXTRA_STYLESHEET 117 HTML_FILE_EXTENSION 115 HTML_FOOTER 116 HTML_HEADER 115 HTML_INDEX_NUM_ENTRIES 118 HTML_OUTPUT 115 HTML_STYLESHEET 116 HTML_TIMESTAMP 118 IDL_PROPERTY_SUPPORT 107 IGNORE_PREFIX 115 IMAGE_PATH 113 INCLUDE_FILE_PATTERNS 128 INCLUDE_GRAPH 130 INCLUDE_PATH 128 INCLUDED_BY_GRAPH 131 INHERIT_DOCS 105 INLINE_GROUPED_CLASSES 107 INLINE_INFO 109 INLINE_INHERITED_MEMB 104 INLINE_SIMPLE_STRUCTS 107 INLINE_SOURCES 113 INPUT 112 INPUT_ENCODING 112 Generated by Doxygen 212 INDEX INPUT_FILTER 113 installation 7 INTERACTIVE_SVG 131 INTERNAL_DOCS 108 JAVADOC_AUTOBRIEF 105 LaTeX 16 LATEX _BATCHMODE 124 LATEX
124. Wizard button in step 1 then a dialog with a number of tabs will appear oo Mode Output Diagrams Provide some information about the project you are documenting Project name Project version or id Specify the directory to scan for source code Source code directory Select Scan recursively Specify the directory where doxygen should put the generated documentation Destination directory Select ox Cancel Figure 21 2 Wizard dialog Project settings 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 Generated by Doxygen 97 Project Output Diagrams Select the desired extraction mode Documented entities only All entities FT Include cross referenced source code in the output Select programming language to optimize the results for Optimize for C output Optimize for Java output O Optimize for C output GOD a Figure 21 3 Wizard dialog Mode of operating 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 Generated by Doxygen 98
125. XML_PROGRAMLISTING 22 12 22 2 Project related configuration options DOXYFILE_ENCODING This tag specifies the encoding used for all characters in the config file that follow The default is UTF 8 which is also the encoding used for all text before the first occurrence of this tag Doxygen uses 1ibiconv or the iconv built into 1ibc for the transcoding See http www gnu org software libiconv for the list of possible encodings The default value is UTF 8 PROJECT_NAME The PROJECT_NAME tag is a single word or a sequence of words surrounded by double quotes unless you are using Doxywizard that should identify the project for which the documentation is generated This name is used in the title of most generated pages and in a few other places The default value is My Project 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
126. _BIB_STYLE 125 LATEX _CMD_NAME 123 LATEX_EXTRA_FILES 124 LATEX_FOOTER 124 LATEX_HEADER 124 LATEX _HIDE_INDICES 125 LATEX OUTPUT 123 LATEX _SOURCE_CODE 125 LAYOUT_FILE 111 libiconv 7 license 4 LOOKUP_CACHE_ SIZE 107 MACRO_EXPANSION 127 make 7 MAKEINDEX_CMD_NAME 123 man 16 MAN_EXTENSION 126 MAN_LINKS 126 MAN_OUTPUT 126 MAN_SUBDIR 126 MARKDOWN_ SUPPORT 106 MATHJAX_CODEFILE 122 MATHJAX_EXTENSIONS 122 MATHJAX_FORMAT 121 MATHJAX_RELPATH 121 MAX_DOT_GRAPH_DEPTH 132 MAX_INITIALIZER_LINES 110 MSCFILE_DIRS 132 MSCGEN_PATH 129 MULTILINE_CPP_IS_BRIEF 105 OPTIMIZE_FOR_FORTRAN 106 OPTIMIZE_OUTPUT_FOR_C 106 OPTIMIZE_OUTPUT_JAVA 106 OPTIMIZE_OUTPUT_VHDL 106 output formats 63 OUTPUT_DIRECTORY 104 OUTPUT_LANGUAGE 104 PAPER_TYPE 124 parsing 17 PDF_HYPERLINKS 124 perl 7 PERL_PATH 129 perlmod 199 PERLMOD_LATEX 127 PERLMOD_MAKEVAR_PREFIX 127 PERLMOD_PRETTY 127 PREDEFINED 128 PROJECT_BRIEF 103 PROJECT_LOGO 103 PROJECT_NAME 103 PROJECT_NUMBER 103 QCH_FILE 119 QHG_LOCATION 120 QHP_CUST_FILTER_ATTRS 120 QHP_CUST_FILTER NAME 120 QHP_NAMESPACE 120 QHP_SECT_FILTER_ATTRS 120 QHP_VIRTUAL_FOLDER 120 Qt 7 QT_AUTOBRIEF 105 QUIET 111 RECURSIVE 112 REFERENCED_BY_RELATION 114 REFERENCES_LINK_SOURCE 114 REFERENCES_RELATION 114 REPEAT_BRIEF 104 RTF 16 RTF_EXTENSIONS_FILE 125 RTF_HYPERLINKS 125 RTF_OUTPUT 125 RTF_STYLESHEET_FILE 125 SEARCH_INCLUDES
127. 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 8 Including 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_
128. ae ws 144 a a AE So a ae ee a 145 PAGO names MIEI o eed wee ae Se eS ee ee Gale a Pe ed eee we E 145 APES fa ace sks don A A pa kee Skee A a ee a a 146 MOPWALSSECNON id ee ON A A ed od bh ee bee eS 146 property qualified property name 0 a 146 ADIGIEUIED eGo cee ee ee ee Oe A eo ee ee de we OR SES 146 POTES le Sv ae ee eS Re Qe Pe ee ee N 147 protocol lt name gt lt header file gt lt header name gt o ee 147 APD 2 id e A A A ee ER RES ee eS 147 PUDICSECUON alicia a a a nl A A a O A a 147 AU a e A a ee A A eee a a E 147 welis MAME ki i eke ee sea a a pm e A ly ee es wha 148 Weldted lt NAMES 2445244 e bee e bb behead de bat abe a a G de ke ees 148 welalesalso NAMING Sw eo ke a e eR ae Se e hee k a A 148 Yelatedalso lt MAME 21 00 fia eee oe Ne a ee we A ee a 148 FEO AUER 0 be ee ae a BR SO EE Wa a wa a Ae ee eS 148 Generated by Doxygen vi CONTENTS 2945 A A 149 23 46 struct lt name gt lt header file gt lt header name gt o 149 23 47 typedef typedef declaration lt lt 0 sa o ae ee ee bee ee a 149 23 48 union lt name gt lt header file gt lt header name gt o 202 pee eee 149 23 49 war variable declaration c oco ec 2628 ono rr das py bet erae be hee 149 29 50 Wwhdiflow title forthe flow chart lt lt e ee ee a a 149 23 51 Weakgraup lt name gt ell lt e cee ee ee eee ee ER eee ee ee 150
129. ag determines the format of the warning messages that doxygen can pro duce The string should contain the file line and text tags which will be replaced by the file and line number from which the warning originated and the warning text Optionally the format may contain Sversion which will be replaced by the version of the file if it could be obtained via FILE_VERSION_Fl LTER The default value is SEile Sline 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 standard error stderr 22 5 Configuration options related to the input files INPUT The INPUT tag is used to specify the files and or directories that contain documented source files You may enter file names like myfile 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 Doxygen uses libiconv or the iconv built into libc for the transcoding See the libiconv documentation for the list of possible encodings The default value is UTF 8 FILE PATTERNS If the value of the INPUT tag contains directories you can use the FILE_PATTERNS tag to specify one or more wildcard patterns like cpp and
130. agment 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 YES or hide NO the internal documentation See also section endinternal 23 23 mainpage title If the Ama inpage command is placed in a comment block the block is used to customize the index page in HTML or the first chapter in IATEX The title argument is optional and replaces the default title that doxygen normally generates If you do not want any title you can specify notitle as the argument of mainpage Here is an example x mainpage My Personal Index Page x section intro_sec Introduction This is the introduction section install_sec Installation subsection stepl Step 1 Opening the box A A F FH Generated by Doxygen 144 Special Commands x CEC You can refer to the main page using ref index See also section section section subsection and section page 23 24 memberof lt name gt This command makes a function a member of a class in a similar way as relates does only with this c
131. ail 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 11 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 corresponds 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 11 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 11 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 l
132. all letter theta symbol 3 greek upsilon with hook symbol Y greek pi symbol bullet black small circle horizontal ellipsis three dot leader prime minutes feet double prime seconds inches overline spacing overscore fraction slash script capital P power set Weierstrass p 2 blackletter capital imaginary part 3 Generated by Doxygen 188 HTML commands e amp real blackletter capital R real part symbol R amp trade trade mark sign e amp alefsym alef symbol first transfinite cardinal XN amp larr leftwards arrow lt amp uarr upwards arrow rarr rightwards arrow gt darr downwards arrow harr left right arrow lt gt amp crarr downwards arrow with corner leftwards carriage return amp lArr leftwards double arrow lt e amp uArr upwards double arrow amp rArr rightwards double arrow gt amp dArr downwards double arrow J amp hArr left right double arrow lt e forall for all Y e amp part partial differential e gexist there exists 3 Sempty empty set null set diameter e nabla nabla backward difference V amp isin element of e amp notin not an element of amp ni contains as member 5 amp prod n ary product product sign e amp sum n ary sumation Y minus minus sign amp lowast asterisk operator
133. allation 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 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 2 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 e
134. ally be treated as a brief description one may set QT_AUTOBRIEF to YES in the configuration file 4 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 class 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 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 class Test brief A test class A more detailed class description Here th
135. 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 Generated by Doxygen 78 Customizing the Output 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 14 3 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 XML file you can combine the index and the other files using the XSLT file combine xslt You can use any XML parser to parse the file or use the one
136. ame gt lt header file gt lt header name gt eee eee 138 EEN EMOS lt a A ss eae Ge ee ae ee a Pe A ye ee 138 Wdeigroup NAMES OROUD Ue o e o ee ee A ee a 139 scr path fragment i e d ii o Ped eee ee Ee eh ee bade he 139 ANUIES oct SS we eG Raa RR RRO we RE ee ae ee a bes 139 example lt filename S sir ee eS ee Pe ee ee ee Oe ee A 139 a oe Se os Se a a ee ew GS a eae wR a Be Ra E De a e ee 140 AOS ATM Sicko ae ok ek ee Re A Re eR ee ae G 140 ine Names i ot oa Oh heed ee Pe be ehh Pee See RS ae pS 140 AN funcion declan o o 5 or amp Boat ee A eR ne we ee E eee eS 141 headerfile lt header file gt lt header name gt 00002 eee eee eee 142 ac skp i a eR Pa we ee ee a oe a Se a G 142 ydexcepi lt NAMES 24 224 eb beh 4h e444 64464 e444 6444 b ebb ee ba be wed 142 Umplements MSMES ca Gos wk han iia e A ee he we A 142 ingroup lt groupname gt lt groupname gt lt groupname gt o e 143 interface lt name gt lt header file gt lt header name gt o o 143 A AN A A 143 talpaga IS 220266 4 48 Dk Pee P bee AA ada 143 NNEMPSI L NAMIE Ss sue Ga ak Male Le be ee ee ee ee ea eee oe he ae eS 144 Mame headern o coronna Se eee ERE ee Ee bree Ye ee A 144 namespace AMES oaie ace A eA a de Gk oe ee A ae 144 WPOSUDOIGUDING rd Phe bd be hed beet hee ee bet Ge bed ee bb ee hed 144 overload tunction declaration i c c 26 5 bee hb bee eb ede eb ee h
137. ameter Possible values are in in out and out note the square brackets 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 x 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 anew 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 Sets the position param x y z Coordinates of the position in 3D space Generated by Doxygen 156 Special Commands void setPosition double x double y double z double t f 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
138. aph 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 23 60 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 23 61 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 det ails command is not needed 23 62 else Starts a conditional section if the previous conditional section was not enabled The previous section should have been started with a if ifnot or elseif command See also if ifnot elseif endif 23 63 elseif section label 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 The section label can be a logical expression build of section
139. aram in arg some argument 4 proc ns_proc arg 5 Documented var lc ns_var 6 Some documentation a variable ns_var 8 Documented itcl class c itcl_class 9 eels elass itel class 20 Create object 21 constructor args eval args 22 Destroy object 23 destructor exit 24 Documented itcl method ke itcl_method_x 25 param in arg Argument 26 private method itcl_method_x arg 27 Documented itcl method lc itcl_method_y 28 param in arg Argument 29 protected method itcl_method_y arg 30 Documented itcl method c itcl_method_z 31 param in arg Argument 32 public method itcl_method_z arg 33 Documented common itcl var lc itcl_Var 34 common itcl_Var 35 protectedsection 36 37 variable itcl_varl lt Documented itcl var c itcl_varl 38 variable itcl_var2 39 Documented oo class lc oo_class 40 oo class create oo_class 41 Create object 42 Configure with args 43 constructor args eval Sargs 44 Destroy object 45 Exit 46 destructor exit 47 Documented oo var c oo_var 48 Defined inside class 49 variable oo_var 50 private Documented oo method lc oo_method_x 51 param in arg Argument 52 method oo_method_x arg 53 protected Documented oo method c oo_method_y 54 param in arg Argument 55 method oo_method_y arg 56 public Documented oo method c oo_method_z 57 param in arg Argument 58 method oo_method_z arg 59 60 61 endcode 62
140. arkdown 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 Chapter 5 Markdown Markdown support was introduced in doxygen version 1 8 0 It is a plain text formatting syntax written by John Gruber with the 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 it s 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 secti
141. ase 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 84 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_SKIP_THIS in the config file then all blocks should be skipped by Doxygen as long as ENABLE_PREPROCESSING is set to YES How can change what is after the include in the class documentation In most cases you can
142. ation The default value is NO EXTRACT_STATIC If the EXTRACT_STATIC tag is set to YES all static members of a file will be included in the documentation The default value is NO 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 The default value is YES 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 only methods in the interface are included The default value is NO 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 The default value is NO 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 these members will be included in the various overviews but no documentation section is generated This option has no effect if EXTRACT_ALL is e
143. ayed in a bold font lt B gt Ends a lt B gt section lt BLOCKQUOTE gt Starts a quotation block 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 lt CENTER gt starts a section of centered text lt CENTER gt ends a section of centered text lt CAPTION gt Starts a caption Use within a table only 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 only for C code this command is equivalent to code lt CODE gt Ends a lt CODE gt section Note that only for C code this command is equivalent to endcode lt DD gt Starts an item description lt DD gt Ends an item description lt DFN gt Starts a piece of text displayed in a typewriter font lt DFN gt Ends a lt DFN gt section lt DIV gt Starts a section with a specific style HTML only lt DIV gt Ends a section with a specific style HTML only lt DL gt Starts a description list 182 HTML commands lt DL gt Ends a description list lt DT gt Starts an item title lt DT gt Ends an item title lt E 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
144. bnoimi at gmail dot com Armenian Armen Tangamyan armen dot tangamyan at anu dot edu dot au 1 8 0 Brazilian Portuguese Fabio FJTC Jun Takada Chino jun chino at uol dot com dot br 1 8 0 Catalan Maximiliano Pin max dot pin at bitroit dot com 1 8 0 Albert Mora unreachable amora at iua dot upf dot es Chinese Lian Yang lian dot yang dot cn at gmail dot com 1 8 2 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 almost up to date Gary Lee garywlee at gmail dot com Croatian Boris Bralo boris dot bralo at gmail dot com 1 8 2 Czech Petr P ikryl prikryl at atlas dot cz up to date Danish Poul Erik Hansen pouhan at gnotometrics dot dk 1 8 0 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 ander dot basaundi at gmail dot com 1 8 4 Finnish Antti Laine antti dot a dot laine at tut dot fi 1 6 0 French David Martinet contact at e concept applications dot fr up to date Xavier Outhier xouthier at yahoo dot fr Benoit BROSSE Benoit dot BROSSE at ingenico dot com German Peter Grotrian Peter dot Grotrian at pdv FS dot de 1 8 4 Jens Seidel jensseidel at users dot sf dot net Greek Paul Gessos gessos dot paul at yahoo dot gr 1 8 4 Hungarian Akos Kiss akiss at users dot sourceforge dot net 1 4 6 F ldv ri Gy rgy unreachable foldvari
145. c 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 the configuration file In the case above doxygen will then read both statements i e static CONST_STRING version static CONST_STRING version W2 RRM YS WL KY 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_A S_DEFINED tag A typically example where some help from the preprocessor is needed is when dealing with the language extension from Microsoft __declspec The same goes for GNU s __attribute__ 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 ___ decl spec as some sort of
146. ca aoa G eh we Bs dob AOS aoe A ae a A He A a A ae 171 23 198 enddocbookonly lt lt ise wt be bed eee beet bbe eee de den es 171 Pelee o ate Bas we ea ek Rew Be ee A eae WA ee we See BS 171 Po AMAN o a oR gy A Oh he A ow A Gh eS AA ed A hk O ee ee a 171 ARAL PONE oi Gea ke a a Ey ek See ee Pe a RE AE ao ee des 172 a sa ca Seon ek me ee em A oe Ae gi ea a a e ee hn ae a et A 172 SOAS a cok eae ee OMe PAE Po ee ANN 172 e STOR aoe ee Ske naa BOR hk eee Re EO ee AO ee Ba we eee we Oh Be eS 172 ES LADOS ada A ER A eee de bee ed 172 E couse ok eh be ee ea A a a ae Qe ee A Gk h ip ee a asdi ata 172 a A bee aS eh bod hd bee bee ea eee oe eh eb he ee hed 173 POI OW 1c e aed eb phate eg E keh eee heehee bed we ey bebe had 173 LIA Bec Aten e ek Ganon Be ely A Rone An a Ge eee it dh es Bee ar he Me a BE ds 173 ENDOSO o Oe ee eo ee eo Be Goal e om a ee ee ae be ee 173 E A feats gk eS Sa pe es Be Get i Ge Spee es EADS Ge EE aes Ss 173 23 102 Mimianig block coccion ba we ee PEE REE eR HE oe eed DE E a 173 23 153 image lt format gt lt file gt caption lt sizeindication gt lt size gt 174 AA 174 ESOS MANO a A ee ar ER PR A a A AA de 175 o 2 c02 8 A Ae eR ek eo a Oe BE A ROR a A RR Be eA 175 POS sie Cee Sb eee ee a Pe bee ae OSE PER EE Re 175 e LAO AUN Ga Skank Siok Gece hg a Roe te A a A a SR Eee ee 175 Bo OS VE bee a cake wa AA a ee a a a ae ER ee aa ea ee E 176 ES COMIDA aX dG G Eh Boe Gob RA aoe a a Ae oe A A es as 176
147. cify a number of aliases that act as commands in the documentation An alias has the form name value For example adding sideeffect fpar 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 Generated by Doxygen 106 Configuration TCL_SUBST This tag can be used to specify a number of word keyword mappings TCL only A mapping has the form name value For example adding class itcl class will allow you to use the command class inthe itcl class meaning 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 The default value is NO 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 The default value is NO OPTIMIZE _FOR_FORTRAN Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran sources Doxygen will then generate output that i
148. cify 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 This tag requires that the tag GENERATE_HTMLHELP is set to YES HHC_LOCATION 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 The file has to be specified with full path This tag requires that the tag GENERATE_HTMLHELP is set to YES GENERATE_CHI The GEN ERAT should be included in the master chm file NO The default value is NO This tag requires that the tag GENERATE_HTMLHELP is set to YES E_CHI flag controls if a separate chi index file is generated YES or that it CHM_INDEX_ENCODING The CHM_INDEX_ENCODING is used to encode HtmlHelp index hhk content hhc and project file content This tag requires that the tag GENERATE_HTMLHELP is set to YES BINARY_TOC The BINARY_TOC flag controls whether a binary table of contents is generated YES or anormal table of contents NO in the chm file Furthermore it enables the Previous and Next buttons The default value is NO This tag requires that the tag GENERATE_HTMLHELP is set to YES TOC_EXPAND The TOC_1 EXPAND flag can be set to Y contents of the HTML help documentation and to the tree view
149. 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 Another way to get rules matching debugging information from the flex code is in the following way touch src lt flex code file gt 1 make LEX flex d to remove the rules debug information again touch src lt flex codefile gt 1 make Note that by running doxygen with d lex you get information about which flex codefile is used Generated by Doxygen Chapter 27 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 Doxygen 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 IATEX generator Please report any bugs or problems you find in the Perl
150. ctness of the call graph depends on the doxygen code parser which is not perfect See also section callergraph 23 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 Generated by Doxygen 138 Special Commands 23 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 23 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 something other than lt header file gt This can be useful if the
151. d classes structs unions and interfaces e The namespace element represents the layout of all pages generated for documented namespaces and also Java packages Generated by Doxygen 14 2 Changing the layout of pages 77 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 indication of the type of members that the element represents memberdef Represents the detailed member list on a page member definition Like the me
152. d h brief A Documented file Details xf def MAX a b brief A macro that returns the maximum of la a and la b Details x var typedef unsigned int UINT32 brief A type definition fora Details var int errno brief Contains the last error code warning Not thread safe 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 fn int close int fd brief Closes the file descriptor a fd param fd The descriptor to close x fn size_t write int fd const char x 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 Generated by Doxygen 26 Documenting the code param count The number of bytes to write jx 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 int int close int size_t write int const char x 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
153. d in some cases because it is used to expand environment variables 23 167 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 23 168 lt This command writes the lt character to the output This character has to be escaped because it has a special meaning in HTML 23 169 gt This command writes the gt character to the output This character has to be escaped because it has a special meaning in HTML 23 170 This command writes the character to the output This character has to be escaped in some cases because it is used to prevent auto linking to word that is also a documented class or struct Generated by Doxygen 178 Special Commands 23 171 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 23 172 This command writes a dot to the output This can be useful to prevent ending a brief description when JAVA DOC_AUTOBRIEF is enabled or to prevent starting a numbered list when the dot follows a number at the start of a line 23 173 This command writes a double colon to the output This character sequence has to be escaped in some cases because it is used to reference to documented entities 23 174 This command writes a pipe symbol to the output This cha
154. d 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 The fourth argument is also optional and can be used to specify the width or height of the image This is only useful for IATEX output i e format latex The sizeindication can be either width or height The size should be a valid size specifier in IATEX 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 x image html application jpg x 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 IATEX 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 23 154 latexonly Starts a block of text that will be verbatim included i
155. d of the configuration file are also kept and placed at the end of the file Comments begin with the hash character and ends 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 equal sign and one or more values If the same tag is assigned more than once the last assignment overwrites any earlier assignment For tags 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 should 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 T 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 descr
156. 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 23 17 hideinitializer By default the value of a define and the initializer of a variable are displayed unless they are longer than 30 lines By
157. 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 protected 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 7 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 7 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
158. dot tool CLASS DIAGRAMS Ifthe CLASS DIAGRAMS tag is set to YES doxygen will generate a class diagram in HTML and lATEX 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 Gl The default value is YES 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 DIA_PATH You can include diagrams made with dia in doxygen documentation Doxygen will then run dia to produce the diagram and insert it in the documentation The DIA_PATH tag allows you to specify the directory where the dia binary resides If left empty dia is assumed to be found in the default search path 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 S CJ The default value is Y 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
159. e Indicates that the member documented by the comment block is pure virtual i e it is abstract and has no imple mentation associated with it This command is intended for use only when the language does not support the concept of pure virtual methods natively e g C PHP 4 Generated by Doxygen 148 Special Commands 23 40 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 A String class class String friend int strcmp const String amp const String Y x x Compares two strings int strcmp const String amp sl const String amp s2 Nrelates String A string debug function void stringDebug 23 41 related lt name gt Equivalent to relates 23 42 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 c
160. e to attach a file to it only after submitting the initial bug description You can and are encouraged to 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 19 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
161. e HL ae Ro Se a Ae A A E a 79 18 2 Aliases Witharg menis ocean bY Rew Pa ER DROP eae ee ee 79 15 3 Nesting CUSIOMICOMIMGNG x24 nce ace a a ee A A e Oe e h Gok ee ee 80 16 Link to external documentation 81 Generated by Doxygen IV CONTENTS 17 Frequently Asked Questions 18 Troubleshooting Tel Known PODEM ooi oe ied eaedibeivhetateda bbs bbie Beet eee hiws A o e wb ape ae AN 168 Howtoreponta Dug oca Bay ee Ge E a ee ae eae a ale a ll Reference Manual 19 Features 20 Doxygen usage 20 7 Fine tming the Quiet o ae ee oe ge Dok SOY Gt A ed ee ee ae ee 21 Doxywizard usage 22 Configuration 22A WEAN se oe a he Sco Be bb se BS NN 22 2 Project related configuration optionS lt e lt ooo ee ee e i 223 Build related contiguration options 2 224 aa ee eee ee eee Re tandi i 22 4 Configuration options related to warning and progress Messages o o 22 5 Configuration options related to the input files 0 o e 22 6 Configuration options related to source browsing o e e e 22 7 Configuration options related to the alphabetical class index o o 22 8 Configuration options related to the HTML output o e e eo 22 9 Configuration options related to the LaTeX output o es 22 10 Configuration options related to the RTF output 2 2 e e 22 11 Configuration options related to the man pa
162. e a 23 96 ES ionic Eee tia asa ae Ie ic a 23 135 MAN cf hd hee de ear we Sa mw ee Sea ae 23 122 NOISES Sar dea a Wee Ba a ew ae ae al A 23 62 e a ea esa a EA Be ee ae h 23 52 AS ee OR Re Dia ENa 23 63 MAURO o a A a aK Bs a Re ih vet Ee a 23 53 MOMs ae hed tin An ote Wack tas Gogh Jags E E a actin eed 23 136 NAUMNOIS iii e eee ee de a 23 54 NOMACOGE oo a ek ce E E oa 23 137 We Gis Sas at cate aM ne co St te ie tera Ge caste a A 23 123 AAN iid ect Gd eo A 23 64 O 23 55 enddocbookonly lt lt a ore soe toe sd enaa 23 138 UE o ii Bale eta ees else ew a RR 23 56 o a be ee Aw Boe a a 23 139 DNS eit as id itll Big oe Sh ths a dh Ack a feed ane hea 23 124 WeMNMIOMY ooo ee ee es we a ed 23 141 Nealigraph lt a Pe Ed ee 23 3 NENG ce eee ee ee Se ae a 23 65 AMECA lt lt A cen a wal a a o 23 4 o A 23 12 e AE Ge ee Sd 23 5 CORSO aa a ena he a Bia ot 23 142 MONG on a cee doce ME Da a we a 23 97 SONNE A 23 98 o A EE E E E EE E oP ee 23 6 Yendmanonly o a a ee e s 23 143 ee o a a a E E EE E 23 125 OSO 225 ca a A A ad Pa 23 140 A GS we ee a ee ee EES a 23 57 pa o 0 Ss Sw ee a deeb wae 23 74 a GE wa o7 SR ecco 2 De Rae thin Be Ged fave 28 127 o sida a a ee a eS Oe Gee Ses 23 144 COPIAS ccc ke we a es OR Ree ae 23 128 o AA oe ne ow ee ee ee 23 103 COPADO oc er bole a he ew A 23 126 ROMERA ea ee ee o a Ha a 23 145 CORR iu oa dont on Bee cca ase 23 58 AMO a sc aos aladi a oie ee ws eh hci 23 146 MAE o a We A Ge Gt BAe E i Gee 23 59 ORUM og ee es Ps e D
163. e code fragments it is very well possible that some valid piece of C C code is not handled properly If you find such 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 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 sectioning commands are an important exception 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 beca
164. e information like class diagrams cross references and formulas will be lost 3 3 6 DocBook output Doxygen can also generate output in the DocBook format How to process the DocBook output is beyond the scope of this manual Generated by Doxygen 3 4 Step 3 Documenting the sources 17 3 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
165. e is NO T 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 tag requires that the tag FILTER_SOURCE_FILES is set to YES E USE_MDFILE_AS MAINPAGE If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that is part of the input its contents will be placed on the main page index html This can be useful if you have a project on for instance GitHub and want to reuse the introduction page also for the doxygen output 22 6 Configuration options related to source browsing SOURCE_BROWSER f 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 that also VERBATIM_HEADERS is set to NO The default value is NO INLINE_SOURCES Setting the INLINE_SOURCES tag to YES will include the body of functions classes and enums directly into the documentation The default value is NO T STRIP_CODE_COMMENTS Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any special comment blocks from generated source code fragments
166. e 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 5 Mac OS X Doc Sets If you are running doxygen on Mac OS X 10 5 or higher then you can make a doc set out of the HTML files produced by doxygen A doc set consists of a single directory with a special structure containing the HTM L 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 Generated by Doxygen 13 1 External Indexing and Searching 67 6 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
167. e special command class is used to indicate that the comment block contains documentation for the class Test Other structural commands are e Xstruct to document a C struct e union to document a union e enum to document an enumeration type Generated by Doxygen 4 1 Special comment blocks 25 e fn to document a function e var 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 e 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 xx 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 x file structcm
168. e symbols given their name and scope Since this can be an expensive process and often the same symbol appears 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 0 corresponding to a cache size of 21 65536 symbols At the end of a run doxygen will report the cache usage and suggest the optimal cache size from a speed point of view Minimum value 0 maximum value 9 default value 0 22 3 Build related configuration 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 respectively EXTRACT_STATIC tags are set to YES Generated by Doxygen 108 Configuration Note This will also disable the warnings about undocumented members that are normally produced when WARNINGS is set to YES The default value is NO EXTRACT PRIVATE Ifthe EXTRACT_PRIVATE tag is set to YES all private members of a class will be included in the documentation The default value is NO EXTRACT _PACKAGE lf the EXTRACT_PACKAGE tag is set to YES all members with package or internal scope will be included in the document
169. e the HAVE_DOT option in the configuration file If you want to produce compressed HTML files see GENERATE_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 MikTex and proTeXt Ghostscript can be downloaded from Sourceforge After installing ATEX 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 2 6 Tools used to develop doxygen 11 2 6 Tools used to develop doxygen Doxygen was developed and tested under Linux amp MacOSX using the following open source tools e GCC version 4 6 3 Linux and 4 2 1 MacOSX e GNU flex version 2 5 35 GNU bison version 2 5 Linux and 2 3 MacOSX e GNU make version 3 81 e Perl version 5 12 e TeX Live 2009 or later Generated by Doxygen 12 Installation Generated by Doxygen Chapter 3 Getting Started The
170. e this search method set SEARCHENGINE SERVER_BASED_SEARCH and EXTERNAL_SEARCH all to YES See External Indexing and Searching for configuration details Advantages over option 2 are that this method potentially scales to very large projects It is also possible to combine multiple doxygen projects and external data into one search index The way the interaction with the search engine is done makes it possible to search from local HTML pages Also the search results have better ranking and show context information if available Disadvantages are that is requires a web server that can execute a CGI binary and an additional indexing step after running doxygen 4 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 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 fil
171. ecify 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 23 135 le lt word gt Displays the argument lt word gt in italics Use this command to emphasize words Generated by Doxygen 23 136 em lt word gt 171 Example Typing this is a e 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 23 136 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 la and le To emphasize multiple words use lt em gt multiple words lt em gt 23 137 endcode Ends a block of code See also section code 23 138 enddocbookonly Ends a block of text that was started with a docbookonly command See also section docbookonly 23 139 lenddot Ends a block that was started with dot 23 140 endmsc Ends a block that was started with msc Generated by Doxygen 172 Special Commands 23 141 endhtmlonly Ends a block of text that was started with a ntmlonly command See also section ntmlonly 23 142 endlatexon
172. eclaration 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 brief Test class Details about Test fn const char Test 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 4 FF OF Generated by Doxygen 142 Special Commands See also sections var property and typedef 23 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 name refers to the file that should be included by the application to obtain the
173. ection Starting a section of protected members in a way similar to the protected class marker in C Indicates that the member documented by the comment block is protected i e should only be accessed by other members in the same or derived classes See also sections memberof public private and protected 23 36 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 23 37 public Indicates that the member documented by 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 23 38 publicsection Starting a section of public members in a way similar to the public class marker in C Indicates that the member documented by the comment block is public i e can be accessed by any other class or function See also sections memberof protected private and public 23 39 pur
174. ed n s A Z 1 15 r s 1 15 r 8 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 To create the layout file that represents doxygen s defaults run doxygen with the 1 option You can optionally specify a file name after the option if omitted DoxygenLayout xml will be used as the name of the ayout file Note that if you run doxygen from a directory containing a file called DoxygenLayout xm1 doxygen will parse it automatically even if the LAYOUT_F ILE 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 omit ted This requires the bibtex tool to be installed See also http en wikipedia org wiki BibTeX for more info For IAT X the style of the bibliography can be controlled using LATEX_BIB_STYLE To use this feature you need bibtex and per1 available in the search path Do not use file names with spaces bibtex cannot handle them See also cite for info how to create references 22 4 Configuration options related to warning and progress messages QUIET TheQUIETtagc If QU
175. ed by Doxygen 132 Configuration DOTFILE_DIRS The DOTFILE_DIRS tag can be used to specify one or more directories that contain dot files that are included in the documentation see the dotfile command This tag requires that the tag HAVE_DOT is set to YES MSCFILE_DIRS The MSCFILE_DIRS tag can be used to specify one or more directories that contain msc files that are included in the documentation see the mscfile command DIAFILE_DIRS The DIAFILE_DIRS tag can be used to specify one or more directories that contain dia files that are included in the documentation see the diafile command 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_NOw 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 Minimum value 0 maximum value 10000 default value 50 This tag requires that the tag HAVE_DOT is set to YES 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
176. ed by a space newline or one the following characters lt An emphasis ends if e it is not followed 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 5 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 5 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 With Markdown the actual numbers you use to mark the list have no effect on the HTML output Markdown produces l e standard Markdown treats the following as one list with 3 numbered items Generated by Doxygen 5 4 Debugging of problems 39 1 Iteml 1 Item2 1 Item3 Doxygen however requires that the numbers used as marks are in strictly ascending order so the above example would produce 3 lists with one item An item with an equal or lower number than the precedi
177. ef Errors page Errors page contents x Nerror ERROR 101 in case a file can not be opened Check about file system read write access x define MY_ERR_CANNOT_OPEN_FILE 101 x Nerror ERROR 102 in case a file can not be closed Check about file system read write access x define MY_ERR_CANNOT_CLOSE_FILE 102 with error defined as ALIASES error Xxrefitem my_errors WVV Generated by Doxygen 160 Special Commands Commands to create links 23 95 laddindex text This command adds text to the IATEX index 23 96 lanchor lt word gt This command places an invisible named anchor into the documentation to which you can refer with the Wref com mand Note Anchors can currently only be put into a comment block that is marked as a page using page or mainpage mainpage See also section ref 23 97 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 BibTeX label that can be found in one of the bib files listed in CITE_BIB_FILES For the IATEX 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 in the search path 23 98 endlink This command ends a link that is started with the link command See also section link 23 9
178. elds with name name and args in the raw search data e tag the name of the tag file as found in the field with name tag in the raw search data e url the name of the relative URL to the documentation as found in the field with name url in the raw search data fragments an array with O or more fragments of text containing words that have been search for These words should be wrapped in lt span class h1 gt and lt span gt tags to highlight them in the output Generated by Doxygen Chapter 14 Customizing the Output Doxygen provides various levels of customization The section Minor Tweaks discusses what to do if 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 14 1 Minor Tweaks The next subsections describe some aspects that can be tweaked with little effort 14 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 14 1 2 Navigation By default
179. ener 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 Generated by Doxygen 18 Getting Started Generated by Doxygen Chapter 4 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 4 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 4 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 a
180. enter center alignment AlignRight right alignment No other types of alignment are supported Note For nested lists HTML commands should be used Equivalent to arg 23 157 An Forces a new line Equivalent to lt br gt and inspired by the print f function 23 158 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 Generated by Doxygen 176 Special Commands Example the p x and Xp 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 multiple words lt tt gt 23 159 Artfonly 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 sections manonly xmlonly latexonly htmlonly and docbookonly 23 160 verbatim Starts a block of text that will be verbatim included in the documentation The block should end with a endverbatim command All commands are disabled in a verbatim block Warning Make sure you include a endverbatim command for each verbat im command or the parser will get con fused
181. ents 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 functionality of the older method was changed or enriched the TranslatorAdapter_x_y_z class may use the obsolete method to 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 x 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 n
182. eprocessing 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 Generated by Doxygen 40 Markdown During Markdown preprocessing no errors are produced Anything that does not 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 Doxygen Chapter 6 Lists Doxygen provides a number of ways to create lists of items Using dashes By putting a number of column aligned minus signs at the start of a line a bullet list will automatically be gener ated Instead of the minus sign also plus or asterisk x can be used Numbered lists can also be generated by using a minus followed by a hash or by using a number followed by a dot Nesting of lists is allowed and is based on indentation of the items Here is an example A list of events mouse events mouse move event mouse click event n More info about the click event mouse double click event keyboard events 1 key down event 2 key up event More text here F FF FF F FF OF The result will be A list of eve
183. equires that the tag GENERATE_HTML is set to YES T ET tag can be used to specify an additional user defined cascading style sheet that is included after the standard style sheets created by doxygen Using this option one can overrule certain style aspects This is preferred over using HTML_STYLESHEET since it does not replace the standard style sheet and is therefor more robust against future updates Doxygen will copy the style sheet file to the output directory Here is an example stylesheet that gives the contents area a fixed width body background color CCC color black margin 0 div contents margin bottom 10px padding 12px margin left auto margin right auto width 960px background color white border radius 8px titlearea background color white hr footer display none footer background color AAA This tag requires that the tag GENERATE_HTML is set to YES HTML EXTRA FILES The HTML_EXTRA_FILES tag can be used to specify one or more extra images or HTML _COLORSTYLE_HUE The HTML_COLORSTYLI 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_FOO TER 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 command
184. er Doxygen will invoke an external search engine pointed to by the SEARCHENGINE_URL option to obtain the search results Doxygen ships with an example indexer doxyindexer and search engine doxysearch cgi which are based on the open source search engine library Xapian See the section External Indexing and Searching for details The default value is NO This tag requires that the tag SEARCHENGINE is set to Y GI n Generated by Doxygen 22 9 Configuration options related to the LaTeX output 123 SEARCHENGINE_URL The SEARCHENGINE_URL should point to a search engine hosted by a web server which will return the search results when EXTERNAL_SEARCH is enabled Doxygen ships with an example indexer doxyindexer and search engine doxysearch cgi which are based on the open source search engine library Xapian See the section External Indexing and Search ing for details This tag requires that the tag SEARCHENGINE is set to YES SEARCHDATA FILE When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unin dexed search data is written to a file for indexing by an external tool With the SEARCHDATA_FILE tag the name of this file can be specified The default file is searchdata xml This tag requires that the tag SEARCHENGINE is set to YES EXTERNAL SEARCH ID When SERVER_BASED SEARCH and EXTERNAL_SEARCH are both enabled the EXTERNAL_SEARCH_ID tag can be used as an identifier for the project T
185. er 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 5 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 Generated by Doxygen 5 3 Doxygen specifics 37 5 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 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 mainpage Documentation that will appear on the main page If a page has a label you can link to it using ref as is
186. f 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 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 xx 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 o
187. f 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 organizer 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 197 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
188. f the use of these comment blocks x A test class x class Test public x x An enum type The documentation block cannot be put after the enum enum EnumType int EVall lt enum value 1 int EVal2 lt enum value 2 x y void member lt a member function protected int value lt an integer value i 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 4 1 1 2 Examples Here is an example of a documented piece of C code using the Qt style A test class fal A more elaborate class description class Test 1 public An enum x More detailed enum description enum TEnum TVal1 lt Enum value TVall TVal2 lt Enum value TVal2 IVal3 lt Enum value TVal3 Enum pointer Details xenumPtr Enum variable Details enumVar A constructor jx A more elaborate description of the constructor Test A destructor Generated by Doxygen 4 1 Special comment blocks 23 Ir A more elaborate description of the destructor Test A normal member taking two arguments and returning an integer value param a an integer argument
189. fault value is NO This tag requires that the tag GENERATE_MAN is set to YES 22 12 Configuration options related to the XML output GENERATE_XML If the G EN ERAT E_XML tag is set to YES doxygen will generate an XML file that captures the structure of the code including all documentation The default value is NO 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 The default directory is xm1 This tag requires that the tag GENERATE_XML is set to YES 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 The default value is Y ES This tag requires that the tag GENERATE_XML is set to YES 22 13 Configuration options related to the DOCBOOK output GENERATE_DOCBOOK If the GEN ERATI EF DOCBOOK tag is set to YES doxygen will generate Docbook files that can be used to generate PDF The default value is NO Generated by Doxygen 22 14 Configuration options for the AutoGen Definitions output 127 DOCBOOK_OUTPUT The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put If a relative path is entered the val
190. fault value is NO If the G EN ERAT E_MA N tag is set to YES doxygen will generate man pages for classes and 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 A directory man3 will be created inside the directory specified by MAN_OUTPUT The default directory is man This tag requires that the tag GENERATE_MAN is set to YES MAN EXTENSION The MAN EXT ENSI ON tag determines the extension that is added to the generated man pages In case the manual section does not start with a number the number 3 is prepended The dat at the beginning of the MAN 23 The default value is This tag requires that the tag GENERATE_MAN is set to YES EXT ENSION tag is optional MAN _ SUBDIR The MAN_SUBDIR tag determines the name of the directory created within MAN_OUTPUT in which the man pages are placed If defaults to man followed by MAN_EXTENS TION with the initial removed This tag requires that the tag GENERATE_MAN is set to YES 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 de
191. 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 belong to the same semantic group Generated by Doxygen 46 Grouping A member group is defined by a 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
192. file list If left blank the directory from which doxygen is run is used as the path to strip Note that you can specify absolute paths here but also relative paths which will be relative from the directory where doxygen is started This tag requires that the tag FULL_PATH_NAMES is set to Y1 Gl S 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 list of 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 The default value is NO JAVADOC_AUTOBRIEF Ifthe JAVADOC_AUTOBRIEF tag 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 Javadoc style will behave just like regular Qt style comments thus requiring an explicit brief command for a brief description The default value is NO QT_AUTOBRIEF Ifthe OT_AUTOBRIEF tag is set to YES then doxygen will interpret the first line until the first dot of a Qt style
193. 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 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 da
194. 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 Minimum value 0 maximum value 1000 default value 0 This tag requires that the tag HAVE_DOT is set to YES 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 lead to badly anti aliased labels on the edges of a graph i e they become hard to read The default value is NO This tag requires that the tag HAVE_DOT is set to YES 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 The default value is NO Gl This tag requires that the tag HAVE_DOT is set to YES GENERATE_LEGEND If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page ex plaining the meaning of the various boxes and arrows in
195. following two paragraphs If a doxygen comment block ends with a line containing only code or 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 verbatin all code until a line only containing tXendverbat im or endverbatim 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 Generated by Doxygen 4 1 Special comment blocks e oo class create Class e co define OO Class definition method Class method definitions constructor Class constructor destructor Class destructor e public Set protection level protected Set protection level e private Set protection level Following is an example using doxygen style comments 1 file tclexample tcl 2 File documentation 3 verbatim 4 5 Startup code 6 exec tclsh 0 sq 7 endverbatim 8 Documented namespace c ns 9 The code is inserted here 0 code 1 namespace eval ns 2 Documented proc c ns_proc 3 p
196. 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_EXTRA_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 Generated by Doxygen 22 8 Configuration options related to the HTML output 121 Since the tree basically has the same information as the tab index you could consider setting DISABLE_l NDEX to YES when enabling this option The default value is NO This tag requires that the tag GENERATE_HTML is set to Y Gl S ENUM_VALUES_PER_LINE The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that doxygen will group on one line in the generated HTML documentation Note that a value of 0 will completely suppress the enum values from appearing in the overview section Minimum value 0 maximum value 20 default value 4 This tag requires that the tag GENERATE_HTML is set to YES 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 Minimum value 0 maximum value 1500 default value 250 This tag requires that the tag
197. formation related to your trans lator 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 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 implemented methods will always return the English result Such translators are marked using the 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 178 177 177 amp 177 178 178 178 VE 178 lt 177 gt 177 176 177 VI 178 177 a 166 addindex 160 addtogroup 136 150
198. fraction one quarter i vulgar fraction one half fraction one half 5 vulgar fraction three quarters fraction three quarters 3 inverted question mark turned question mark latin capital letter A with grave latin capital letter A grave A latin capital letter A with acute A latin capital letter A with circumflex A latin capital letter A with tilde A latin capital letter A with diaeresis A latin capital letter A with ring above latin capital letter A ring A latin capital letter AE latin capital ligature AE AE latin capital letter C with cedilla latin capital letter E with grave E latin capital letter E with acute E latin capital letter E with circumflex E latin capital letter E with diaeresis E latin capital letter with grave latin capital letter with acute latin capital letter with circumflex latin capital letter with diaeresis latin capital letter ETH D Generated by Doxygen 185 e amp Ntilde latin capital letter N with tilde e amp Ograve latin capital letter O with grave amp Oacute latin capital letter O with acute e Ocirc latin capital letter O with circumflex O e amp Otilde latin capital letter O with tilde O 0uml latin capital letter O with diaeresis e amp times multiplication sign x e Oslash latin capital letter O with stroke latin capital letter O slash e amp Ugrave latin capital letter U with gra
199. 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 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
200. function The text of the paragraph has no special internal structure All visual enhancement commands may be used inside the paragraph Multiple adjacent A 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 23 82 returns description of the return value Equivalent to return 23 83 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 paragraph Multiple adjacent retval commands will be joined into a single paragraph Each return value description will start on a new line The ret val description ends when a blank line or some other sectioning command is encountered 23 84 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 ob
201. 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 ___ dec l spec dl lexport is removed before doxygen parses the source code Similar settings can be used for removing ___ at tr ibute__ expressions from the input ENABLE _PREPROCESSING YES MACRO_EXPANSION YES EXPAND_ONLY_PREDEF YES PREDEFINED __attribute__ x For a more complex example suppose you have the following obfuscated code fragment of an abstract base class called TUnknown A reference to an IID x ifdef _ cplusplus define REFIID const IID amp else define REFIID const IID 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 REF IID 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 ma
202. ge output 2 2 ee 0 22 12 Configuration options related to the XML output o e e e 22 13 Configuration options related to the DOCBOOK output o o e 2 22 14 Configuration options for the AutoGen Definitions output 2 2 22 ee e 22 15 Configuration options related to the Perl module output o e e 22 16 Configuration options related to the preprocessor 2 2 ee es 22 17 Configuration options related to external references 0 e 22 18 Configuration options related to the dot tool 0 o e ee pS o A eee ob a ha ee eee ee a aA wee we RR de 4 23 Special Commands P31 o case Skeid oe Roe dy oe wa ek a a aw Bw a A ae A ee a AA ee G foe aarp lt name e MIG e a badd av bi ee been ee hed Sere Pee Seeded 8S 239 MOANA os ee he he A ee ie aD te ee be foe AUSTRADE e a8 be ee ae ER Baer OR Ge Wi a Ba a ek ee we Eee 83 87 87 88 88 89 91 93 93 95 Generated by Doxygen CONTENTS Vv 23 5 23 6 23 7 23 8 23 9 23 10 23 11 23 12 23 13 23 14 23 15 23 16 23 17 23 18 23 19 23 20 23 21 23 22 23 23 23 24 23 25 23 26 23 27 23 28 23 29 23 30 23 31 23 32 23 33 23 34 23 35 23 36 23 37 23 38 23 39 23 40 23 41 23 42 23 43 23 44 category lt name gt lt header file gt lt header name gt o 138 class lt n
203. get 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 For items taking an integer value from a range a spinbox is used For free form string type options there is a one line edit field 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 M REPEAT_BRIEF OUTPUT_LANGUAGE English a TAB_SIZE 8 STRIP_FROM_PATH E Users dimitri Figure 21 6 Some options from the Expert 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 Generated by Doxygen 100 Doxywizard usage Doxywizard Help Open 0 Save As S Recent configurations Users dimitri temp doxygen diagrams cfg Set as default U
204. gt section e lt SUP gt Starts a piece of text displayed in superscript e lt SUP gt Ends a lt SUP gt section lt TABLE gt starts a table e lt TABLE gt ends a table e lt TD gt Starts a new table data element e lt TD gt Ends a table data element e lt TH gt Starts a new table header e lt TH gt Ends a table header e lt TR gt Starts a new table row e lt TR gt Ends a table row lt TT gt Starts a piece of text displayed in a typewriter font e lt TT gt Ends a lt TT gt section lt KBD gt Starts a piece of text displayed in a typewriter font e lt KBD gt Ends a lt KBD gt section e lt UL gt Starts an unnumbered item list e lt UL gt Ends an unnumbered item list lt VAR gt Starts a piece of text displayed in an italic font e lt VAR gt Ends a lt VAR gt section The special HTML4 character entities The list of entities with their descriptions has been taken from Character entity references in HTML 4 Portions International Organization for Standardization 1986 Permission to copy in any form is granted for use with conforming SGML systems and applications as defined in ISO 8879 provided this notice is included in all copies amp nbsp no break space non breaking space e amp iexcl inverted exclamation mark j cent cent sign pound pound sign e amp curren currency sign JU yen yen sign yuan sign Y amp brvbar
205. h as config cpp As a workaround use debug as a configure option or omit the 02 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 Generated by Doxygen 10 Installation tmake error qtools pro 70 Syntax error then first type export LANG before running make 2 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 modern versions of bison and flex see http sourceforge o net projects winflexbison After installation and adding them to your path rename win_flex exe to flex exe and win_bison exe to bison exe Furthermore you have to install python version 2 see http www python org
206. hat comments that you may have added in the original configuration file will be lost 20 1 Fine tuning the 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 Doxyf ile and process that When this is also not found it will used the default settings For ATEX output you can generate the first and last part of refman tex see LATEX_HEADER and LA TEX_FOOTER and the style sheet included by that header normally doxygen st y using the following command 94 Doxygen usage doxygen w latex header tex footer tex doxygen sty lt config_file gt If you need non default options for instance to use extra IATEX packages you need to make a config file with those options set correctly and then specify that config file after the generated files make a backup of the configuration file first so you don t loose it in case you forget to specify one of the output files For RTF output you can generate the default style sheet file see RTF_STYLESHEET_FILE using doxygen w rtf rtfst
207. hat is to be done o o 158 2392 WOFSION Version MUIMDEF ces a Ee a Be ee ee ee ee Wee 158 23 02 Warning WAMING message i oo c aca a ciar ae ee A ee 159 23 94 xrefitem lt key gt heading list title text 2 2 22 00000022 eee 159 pt 6X0 ocene GR Ae ape ee Moe we a A ee ee Se ee me ee E 160 29 96 ANCHOR A WON o ee a ee a ee ee ee Re ee ee 160 2397 Some SIGE e koe G eh Bos ob RAE Aw EP es A ee A aE Bes 160 29 98 ONdwInK 224006 5 e464 e4h8 Deo wee OhEESE REE SEEDS hee be EE EES 160 2399 Sink lt link OBEC sj law Ree Ble ee Re eae BRE a bok we a Ges RS 160 23 100 yof Ramas MET ms Gs kee Re ee A ee AR ee ee A 160 So 401 reem SNAG nr a haw Son Ga Soe SA eR a RRS AS SE a be ee de eS 161 a wee s hoe RAN 161 So ANG o AAA ad ws 161 20 104 subpage names text ss eae Re Re A we eh ee 161 23 100 ablSolcomienks cd ee ee Ree Se be ee ee ba ce a 162 23 106 section lt section name gt sectiontitle 2 2 o 162 23 107 subsection lt subsection name gt subsection title o o 162 23 108 subsubsection lt subsubsection name gt subsubsection title 162 23 109Wparagraph lt paragraph name gt paragraph title 2 2 o o ee 163 23 tO doninecude lt TRERAHAING gt oe io o aa a E E ee 163 231 includes SAINI ica ad a a RA a A ee E 164 23 112 mcludelIneno lt TMSNAMES oc onore ra A a a ee
208. he 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 introduced 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 http developer apple com tools creatingdocsetswithdoxygen html for more information The default value is NO This tag requires that the tag GENERATE_HTML is set to YES DOCSET_FEEDNAME This tag determines the name of the docset feed A documentation feed provides an um brella under which multiple documentation sets from a single provider such as a company or product suite can be grouped The default value is Doxygen generated docs This tag requires that the tag GENERATE_DOCSET is set to YES DOCSET_BUNDLE_ID This tag specifies a string that should uniquely identify the documentation set bundle This should be a reverse domain name style string e g com mycompany MyDocSet Doxygen will append docset to the name The default value is org doxygen Project This tag requires that the tag GENERATE_DOCSET is set to YES DOCSET_PUBLISHER_ID The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely ide
209. hes 164 ES ME PARTE ai ir a A A a A Se es GE Es 164 2 IAE DANCIN a A A ee ee ER dd A eS GS 164 231 SADISMO pe ion e a AA a a ee ee es 165 22116 1ippot lt Temamas DOCK IG gt e oc a rar a AA 165 A A AE NN 165 22118 Werbinclude lt TIETAMES o cromo a ee ee a a 166 231 TS Viminciuas lt ie name o orar ra ee ee ER Ree ee 166 23 120 Vatexinclude lt Tle NaMe gt 2 0405 45 22 Bebe Re ee ee a ee ms 166 Pode SWIG ee eae he he he bed ee Eb SERGE ERE AA AE ee 166 23 122 arg Mendes op boca gos a ca BS A ee ER A ee Re ee we hee ES 166 pa ga id cd okey dy alg he RUE RA Pte WB eh We ee a Oe 167 23 124 WON ca ce Pe aa he RO RD a Re ee ee ee a 167 Generated by Doxygen vill CONTENTS SRS COGS wore it eS ROG ek RDA SEEDS ES EPS EEE 2S 167 23 120 copde SIINK OOIGOTS on ga kee Pewee A eR ee ee AR a ee a a G 168 23127 Copy Drei IMSS osos ae ow a Ge Ba ee a ee eo ee a a a ee 168 23 128 Copydgiaile lt IED 2 ca ee sk eee Swe ee AR 168 29 T29 AGCHOOKONIY i bk et Bh eek be Be bee bad bh ee EE REL EE AE a 168 BOAO 2 4 boty at e E E a we RE Bh ae ee Be 169 OT MISS lt a Oe Oe ee Ge Eh A Re ee ee ei eee ee Oa E 169 23 132 doile lt file gt Papi 2 02 42 A bee EAS RR ee ee aE eee ee ee 170 2213 mecie eG eapi ea sii ek wR a RR ee A eA 170 23 1904 diaile lt file gt Capllon a 2ic240 00 he eS Se Se eA EE Re ede ee ews 170 PIII OM a ke PA Re Rode ee ee we ee a me A ee a 170 ES VIC SWORE o ee ee ee ee EO Re ee ee E 171 Bo Wor ENCISO
210. hese projects are related it may be desirable to allow searching for words in all projects from within the documentation of any of the projects To make this possible all that is needed is to combine the search data for all projects into a single index e g for two projects A and B for which the searchdata xml is generated in directories project_A and project_B run doxyindexer project_A searchdata xml project_B searchdata xml and then copy the resulting doxysearch db to the directory where also doxysearch cgi is located The searchdata xml file doesn t contain any absolute paths or links so how can the search results from multiple projects be linked back to the right documentation set This is where the EXTERNAL SEARCH_ID and EXTRA_SEARCH_MAPPINGS options come into play To be able to identify the different projects one needs to set a unique ID using EXTERNAL_SEARCH_ID for each project To link the search results to the right project you need to define a mapping per project using the EXTRA_SEAR CH_MAPPINGS tag With this option to can define the mapping from IDs of other projects to the relative location of documentation of those projects So for projects A and B the relevant part of the configuration file could look as follows project_A Doxyfile EXTERNAL _SEARCH_ID EXTRA_SEARCH_MAPPINGS A B project_B html oll Generated by Doxygen 70 Searching for project A and for project B projec
211. his is useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple projects and redirect the results back to the right project This tag requires that the tag SEARCHENGINE is set to YES EXTRA_SEARCH MAPPINGS The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen projects other than the one defined by this configuration file but that are all added to the same external search index Each project needs to have a unique id set via EXTERNAL_SEARCH_ID The search mapping then maps the id of to a relative location where the documentation can be found The format is EXTRA_SEARCH_MAPPINGS tagnamel locl tagname2 loc2 This tag requires that the tag SEARCHENGINE is set to YES 22 9 Configuration options related to the LaTeX output GENERATE_LATEX If the GENERATE_LATEX tag is set to YES doxygen will generate IATEX output The default value is YES 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 The default directory is latex This tag requires that the tag GENERATE_LATEX is set to YES LATEX_CMD_NAME The LATEX_CMD_NAME tag can be used to specify the ATEX command name to be in voked Note that when enabling USE_PDFLATEX this option is only used for generating bitmaps for formulas in the HTML output but not in the Makef
212. i e when writing 0 if OK n gt 1 if NOK the second line will not be seen as a block quote 5 1 4 Lists Simple bullet lists can be made by starting a line with or 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 Make sure to also read Lists Extensions for doxygen specifics 5 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 paragraph 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 5 1 Standard Markdown 33 5 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 5 1 7 Emphasi
213. iate Axref1ist 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 1 in the example above 15 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 xx This is a Bold bold Emph and Emphasized text fragment which will expand to x x This is a lt b gt bold lt em gt and lt em gt Emphasized lt b gt text fragment Generated by Doxygen Chapter 16 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 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
214. ile that is written to the output directory The default file is Latex This tag requires that the tag GENERATE_LATEX is set to YES MAKEINDEX_CMD_NAME The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate index for IATEX The default file is makeindex This tag requires that the tag GENERATE_LATEX is set to YES 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 may help to save some trees in general The default value is NO This tag requires that the tag GENERATE_LATEX is set to YES Generated by Doxygen Configuration PAPER _ TYPE The PAPER_TYPE tag can be used to set the paper type that is used by the printer Possible values are a4 210 x 297 mm letter 8 5 x 11 inches legal 8 5 x 14 inches and executive 7 25 x 10 5 inches The default value is a4 This tag requires that the tag GENERATE_LATEX is set to YES 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 This tag requires that the tag GENERATE_LATEX is set to YES LATEX_HEADER The LATEX_HEADER tag can be used to specify a personal IATEX header for the generated
215. 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 13 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 7 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 presen
216. 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 class Test y class Test class h inc class h x brief This is a test class Some details about the Test class 23 7 def lt name gt Indicates that a comment block contains documentation for a define macro Example file define h brief testing defines This is to test the documentation of defines x def MAX x y Computes the maximum of a x and a y 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 lt Computes the minimum of Na x and la y Generated by Doxygen 23 8 defgroup lt name gt group title 139 23 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 g
217. ing include or dontinclude until it finds a line that contains the specified pattern Generated by Doxygen 23 115 skipline pattern 165 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 dontinclude for an example 23 115 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 23 116 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
218. ion of a cl and la c2 k el lxte2sk ol YAOI Coord add Coord cl Coord c2 i e Generated by Doxygen Chapter 12 Output Formats The following output formats are directly supported by doxygen HTML Generated if GENERATE _HTML is set to YES in the configuration file lATEX Generated if GENERATE_LATEX is set to YES in the configuration file Man pages Generated if GENERATE_MAN is set to YES in the configuration file RTF Generated if GENERATE_RTF is set to YES 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 GENERATE_XML is set to YES in the configuration file Docbook Generated if GENERATE _DOCBOOOK is set to YES 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_HTMLHELP is set to YES Qt Compressed Help qch Generated by Qt s qhelpgenerator tool from the HTML output if GENERATE _QHP is set to YES Eclipse Help Generated from HTML with a special index file that is generated when GENERATE_ECLIPSEHELP is setto YES XCode DocSets Compiled from HTML with a special index file that is generated when GENERATE_DOCSET is set to YES PostScript Generated from the IATEX output by running make ps
219. iptions of the tags grouped by category ABBREVIATE BRIEF ooo cor E a a ae i 22 2 CLANG_ASSISTED_PARSING 22 6 ALASES ac ba ER a e ee Bee td 222 OLANG OPTIONS ooo ee ee eee ee A 22 6 ALLEXTERNALS acabes Be a it 22 17 CLASS DIAGRAMS 0 6 anpa ee ee ee 22 18 ALLOW UNICODE NAMES 22 2 CLASS GRAPP ooi i a a as sed a 22 18 ALPHABETIGAL INDEX bo porga ea Bacini a 22 7 COLLABORATION GRAPH 22 18 ALWAYS DETAILED SEG ue o t E EA es 222 OLS IN ALPHA INDEX o ai soea ee su ek 227 AUTOUNK SUPPORT v p bie a p ahpa at i 22 2 GOMPACGTILSTEA co ga a E aS oe A 225 BINARY TOG ado Pines ee de alien So eae i 22 8 COMPACT RTE o coa we a ey ses a 22 10 BRIEF MEMBER DESO 2 bi cias einen Soup a 22 2 OPP CL SUPPORT ose E a a S bere GSS 22 2 BUM TINGE STL SUPPORT 2 uc ed ware ee a 222 DREATE SUBDIRS oca ee eee a a 22 2 CALLER GRAPP coi a pis kank anp i a 22 18 DARLE DIRS y oie hha aa a a a eana A 22 18 RAULL GRAPE iaa dip ered he my AARO i a 22 18 DIA PATH a Aon a qe a BAe ah At eed Ga 22 18 GASE SENSE NAMES oc penta e ee a 22 3 DIRECTORY GRAPH s ia pah a e 22 18 DAM PILE 5 go ts Ete bia ec we ah Sh EA a dour i 22 8 DISABLE INDER sodra na ia a sels ES 22 8 CHM_INDEX_ENCODING i secr enga ee es 22 8 DISTRIBUTE GROUP DOG osos sc ep 22 2 CAVE PIB FEES 032 A jade ee ed GPR jad 22 3 DOGBQOK OUTPUT ccia a a p aai oe SS 22 13 102 Configuration DOCSET_BUNDLE 1D 06 0 ees eee eee 22 8 GRAPHICAL_HIERARCHY
220. is NO This tag requires that the tag GENERATE_RTF is set to YES RTF_HYPERLINKS lf the RTF_HYP doxygen generates more compact RTF documents This ERLINKS 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 readers that support those fields Note WordPad write and others do not support links The default value is NO This tag requires that the tag GENERATE_RTF is set to YES 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 See also section Doxygen usage for information on how to generate the default style sheet that doxygen normally uses This tag requires that the tag GENERATE_RTF is set to Y E S 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 This tag requires that the tag GENERATE_RTF is set to Y Gl un Generated by Doxygen 126 Configuration 22 11 Configuration options related to the man page output GENERATE_MAN files The de
221. is short HOWTO explains how to add support for the new language to doxygen Just follow the following 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 doxygen src translator_en h and name it doxygen src translator_ lt your_2_letter_country_code gt h I ll use xx in the rest of this document and XX for the upper case version 3 Edit doxygen src language cpp Add the following code ifdef LANG_XX include lt translator_xx h gt tendif Remember to use the same symbol LANG_XX that was added to doxygen src lang_cfg h Now in setTranslator add Generated by Doxygen 205 ifdef LANG_XX else if L_EQUAL your_language_name theTranslator new TranslatorYourLanguage tendif 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 4 Edit doxygen src translator_xx h e e Use the UTF 8 capable editor and open the file using the UTF 8 mode Rename TRANSLATOR_EN_H to TRANSLATOR_XX_H twice i e in the ifndef and defin preprocessor commands at the beginning of the file Ea Rename TranslatorEnglish to TranslatorYourLanguage In the member idLanguage
222. 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 example 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 4 1 1 1 Putting documentation after members If you want to document the members o
223. jects Generated by Doxygen 158 Special Commands 23 85 see references Equivalent to sa Introduced for compatibility with Javadoc 23 86 short short description Equivalent to brief 23 87 since text This command 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 23 88 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 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 23 89 throw lt exception object gt exception description Synonymous exception Note the command throws is a synonym for this command See also section exception 23 90 throws lt exception object gt exception description Equivalent to throw 23 91 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 heade
224. ke normal C but will assume all classes use public instead of private inheritance when no explicit protection keyword is present The default value is NO 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 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 The default value is YES DISTRIBUTE_GROUP_DOC f member grouping is used in the documentation and the DISTRIBUTE_GROUe P_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 The default value is NO SUBGROUPING Set the SUBGROUPING tag to YES 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 it to NO to prevent subgrouping Alternatively this can be done per class using the nosubgrouping command The default value is YES INLINE_GROUPED_CLASSES When the INLINE_GROUPED_CLASSES tag is set to YES classes structs and unions are shown inside the gr
225. ke sure that the proper result is fed to doxygen s parser x 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 Generated by Doxygen 57 Note also that preprocessor definitions that are normally defined automatically by the 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 define QList QListT class QListT 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
226. l be preselected If you believe you have found a new bug please report it If you are unsure whether or 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 e Itis 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 chanc
227. l point to the HTML generated by the htags 1 tool instead of doxygen built in source browser The htags tool is part of GNU s global source tagging system see http www gnu org software global global e html You will need version 4 8 6 or higher To use it do the following Install the latest version of global Enable SOURCE_BROWSER and USE_HTAGS in the config file Make sure the INPUT points to the root of the source tree P 0 NY gt Run doxygen as normal Doxygen will invoke ht ags and that will in turn invoke gt ags 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 The default value is NO This tag requires that the tag SOURCE_BROWSER is set to Y GI S VERBATIM_HEADERS lf the VERBATIM_HEADERS tag is set the YES 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 The default value is YES CLANG_ASSISTED_PARSING lf the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the clang parser for more accurate parsing at the cost of reduced performance This can be particularly helpful with template rich C code for which doxygen s built in parser lacks the necessary type information Note The availabili
228. ld gt lt field name name gt QXmlReader setDTDHandler lt field gt lt field name args gt QXm1DTDHandler handler 0 lt field gt lt field name tag gt qtools tag lt field gt lt field name url gt de df6 class_q_xml_reader html a0b24b1fe26a4c32a8032d68ee14d5dba lt field gt lt field name keywords gt setDTDHandler QXmlReader setDTDHandler QXmlReader lt field gt lt field name text gt Sets the DTD handler to handler DTDHandler lt field gt lt doc gt lt add gt Each field has a name The following field names are supported e type the type of the search entry can be one of source function slot signal variable typedef enum enumvalue property event related friend define file namespace group package page dir name the name of the search entry for a method this is the qualified name of the method for a class it is the name of the class etc Generated by Doxygen 13 1 External Indexing and Searching 71 args the parameter list in case of functions or methods e tag the name of the tag file used for this project e url the relative URL to the HTML documentation for this entry e keywords important words that are representative for the entry When searching for such keyword this entry should get a higher rank in the search results e text the documentation associated with the item Note that only words are present no markup Note Due to the potentially large size of
229. le 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 Groups can be nested to form a hierarchy By default a usergroup entry in the navigation tree is a link to a landing page with the contents of the group You can link to a different page using the ur 1 attribute just like you can for the lt tab gt element and prevent any link using url none i e lt tab type usergroup title Group without link url none gt lt tab gt 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 documente
230. le words use lt em gt multiple words lt em gt 23 122 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 Generated by Doxygen 23 123 b lt word gt 167 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 commands should be used Equivalent to li 23 123 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 23 124 c 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 23 125 code lt word gt Starts
231. ly Ends a block of text that was started with a latexonly command See also section latexonly 23 143 endmanonly Ends a block of text that was started with a manonly command See also section manonly 23 144 endrtfonly Ends a block of text that was started with a rtfonly command See also section rtfonly 23 145 endverbatim Ends a block of text that was started with a verbatim command See also section verbatim 23 146 endxmlonly Ends a block of text that was started with a xmlonly command See also section xmlonly Generated by Doxygen 23 147 f 173 23 147 f Marks the start and end of an in text formula See also section formulas for an example 23 148 M Marks the start of a long formula that is displayed centered on a separate line See also section f and section formulas 23 149 f Marks the end of a long formula that is displayed centered on a separate line See also section f and section formulas 23 150 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 23 151 f Marks the end of a formula that is in a specific environment See also section f and section formulas 23
232. ly xmlonly and htmlonly 23 130 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 f class B x class C ef class C 1 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 de c label class C URL ref C b gt c arrowhead open style dashed 4 enddot Note that the classes in the above graph are clickable in the HTML output 23 131 msc Starts a text fragment which should contain a valid description of a message sequence chart See http www mcternan me uk mscgen for examples The text fragment ends with lendmsc 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 xx Sender class Can be used to send a command to the server The receiver will acknowledge the command by calling Ack
233. macros doxylatex tex This is a very simple IATEX document that loads some packages and includes doxyformat tex and doxydocs tex This document is IATEX ed to produce the PDF and DVI documentation by the rules added to doxyrules make Creation of PDF and DVI output this you need to have installed Latex pdflatex and the packages used by doxylatex tex Update your Doxyf ile to the latest version using doxygen u Doxyfile Set both GENERATE_PERLMOD and PERLMOD_LATEX tags to YES in your Doxyfile Run Doxygen on your Doxyfile doxygen Doxyfile Aperlmod subdirectory should have appeared in your output directory Enter the per 1mod subdirectory and run make pdf This should generate a doxylatex pdf with the documentation in PDF format Run make dvi This should generate a doxylatex dvi with the documentation in DVI format Generated by Doxygen 27 3 Documentation format 201 27 3 Documentation format The Perl Module documentation generated by Doxygen is stored in DoxyDocs pm This is a very simple Perl module 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 Sdoxydocs contains a tree like structure composed of three types of nodes strings hashes and lists e Strings These are normal Perl st
234. mber 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 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 xx addtogroup lt label gt Q Ir 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
235. mberdec1 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 di rect orygraph element which represents the graph showing the dependencies between the directories based on the include 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
236. me as the ECLIPSE_DOC_ID value After copying Eclipse needs to be restarted before the help appears The default value is NO This tag requires that the tag GENERATE_HTML is set to Y E Ss 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 The default value is org doxygen Project This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES 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 tabs at top of each HTML page A value of NO enables the index and the value YES disables it Since the tabs in the index contain the same information as the navigation tree you can set this option to YES if you also set GENERATE_TREEVIEW to YES The default value is NO This tag requires that the tag GENERATE_HTML is set to Y E Ss 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
237. mple 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 11 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 enumeration 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
238. mple 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 Generated by Doxygen 140 Special Commands 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 x A Test class x More details about this class class Test public xx An example member function More details about this function void example y void Test example x x Nexample example_test cpp x 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 t t example See also section include 23 12 endinternal This command ends a documentation fragment that was started with a internal command The text between internal and endinternal will only be visible if INTERNAL_DOCS is set to YES 23 13 extend
239. n Generated by Doxygen 162 Special Commands x page advanced Advanced Usage This page is for advanced users Make sure you have first read ref intro the introduction 23 105 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 documentation and not in other documentation blocks and only has effect in the HTML output 23 106 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 notin other documentation blocks See also Section page for an example of the sect ion command 23 107 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 subsect ion command Warning This command only works inside a section of a related page documentation block and notin other documenta tion blocks See also Section page for an example of the subsect ion command 23 108 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 a
240. n example of a typical piece of code using some of the above commands lt summary gt A search engine lt summary gt class Engine EA ARA 114 Air 117 117 117 dot 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 in 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 26 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 A Doc Parser drives drives Figure 26 1
241. n file from standard input st din which can be useful for scripting The 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 x 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
242. n image Caption text ref image png img def img def ref image png Caption text The caption text is optional Generated by Doxygen 5 2 Markdown Extensions 35 5 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 https www example com gt lt ftp www example com gt lt mailto address example com gt lt address example com gt Note that doxygen will also produce the links without the angle brackets 5 2 Markdown Extensions 5 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 5 2 2 Tables Of the 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 A DD A ss an E ses Sa ee A 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 3 5
243. n the documentation E The default value is YES F GENERATE_DEPRECATEDLIST The GEN ERAT D EPR ECAT EDLIST tag can be used to enable YES or disable NO the deprecated list This list is created by putting deprecated commands in the documentation Gl The default value is YES ENABLED SECTIONS The ENABLED_S tions marked by if lt section_label gt ECTIONS tag can be used to enable conditional documentation sec endif and cond lt section_label gt endcond blocks MAX INITIALIZER_LINES The MAX_INITIALIZ ER_LIN ES tag determines the maximum number of lines that the initial value of a variable or macro define can have for it to appear in the documentation If the initializer consists of more lines than specified here it will be hidden Use a value of 0 to hide initializers completely The appearance of the value of individual variables and macros defines can be controlled using showinitializer or hideinitializer command in the documentation regardless of this setting Minimum value 0 maximum value 10000 default value 30 SHOW_USED_FILES Setthe SHOW_US ED_FIL ES tag to NO to disable the list of files generated at the bottom of the documentation of classes and structs If set to Y ES the list will mention the files that were used to generate the documentation S E The default value i
244. n 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 ATEX only block Generated by Doxygen 23 155 manonly 175 See also sections rtfonly xmlonly manonly htmlonly and docbookonly 23 155 manonly 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 into MAN pages You can use the htmlonly and endhtm lonly and latexonly and endlatexonly pairs to provide proper HTML and TeX alternatives See also sections htmlonly ixmlonly rtfonly latexonly and docbookonly 23 156 li item description This command has one argument that continues until the first blank line or until another 1i is encountered The command can be used to generate a simple not nested list of arguments Each argument should start with a 1i command Example Typing Mi c AlignLeft left alignment Mi c AlignCenter center alignment Mi c AlignRight right alignment No other types of alignment are supported will result in the following text e AlignLeft left alignment e AlignC
245. nabled The default value is NO HIDE_UNDOC_CLASSES Ifthe HIDE_UNDOC_CLASSES tag is set to YES doxygen will hide all undocumented classes that are normally visible in the class hierarchy If set to NO these classes will be included in the various overviews This option has no effect if EXTRACT_ALL is enabled The default value is NO HIDE_FRIEND_COMPOUNDS Ifthe HIDE_FRIEND_COMPOUNDS tag is set to YES doxygen will hide all friend class struct union declarations If set to NO these declarations will be included in the documentation The default value is NO 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 these blocks will be appended to the function s detailed documentation block The default value is NO 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 then the documentation will be excluded Set it to YES to include the internal documentation The default value is NO Generated by Doxygen 22 3 Build related configuration options 109 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 and
246. names round brackets amp amp AND OR and NOT Conditional blocks can be nested A nested section is only enabled if all enclosing sections are enabled as well Generated by Doxygen 23 64 endcond 153 See also sections endif ifnot else and elseif 23 64 endcond Ends a conditional section that was started by cond See also section cond 23 65 lendif Ends a conditional section that was started by if or ifnot For each if or ifnot one and only one matching endif must follow See also sections if and ifnot 23 66 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 spe cial 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 command is encountered See section fn for an example 23 67 _ if section label 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
247. 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 written using flex and can be found in src pre 1 For condition blocks 1 f 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 o
248. nd 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 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
249. nd 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 Generated by Doxygen User examples Doxygen supports a number of output formats where HTML is the most popular one I ve gathered some nice examples of real life projects using doxygen These are part of alarger List of projects that use doxygen If you know other projects let me know and Pll add them 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 Acknowledgments Thanks go to 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
250. nerated by Doxygen 22 18 Configuration options related to the dot tool 129 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 The default value is NO EXTERNAL_GROUPS If the EXTERNAL_GROUPS 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 S Gl The default value is Y EXTERNAL_PAGES f the EXTERNAL_PAGES tag is set to YES all external pages will be listed in the related pages index If set to NO only the current project s pages will be listed The default value is YES PERL_PATH The PERL_PATH should be the absolute path and name of the perl script interpreter i e the result of which perl The default file with absolute path is usr bin perl 22 18 Configuration options related to the
251. nerator 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 200 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 IATEX code necessary to generate PDF and DVI output from the Perl Module output using pdf latex 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 27 2 1 To try 1 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 IATEX code This file is not directly LaTeXable doxyformat tex This file contains the IATEX code that transforms the documentation from doxydocs tex into IATEX text suitable to be IATEX ed and presented to the user doxylatex template pl This Perl script uses DoxyModel pm to generate doxytemplate tex a TEX file defining default values for some macros doxytemplate tex is included by doxyformat tex to avoid the need of explicitly defining some
252. nes the RTF output to a single file called refman rtf This file is optimized for importing into the Microsoft Word Certain 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 3 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 xs1t 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 3 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 som
253. ng item will start a new list For example Iteml of list Item2 of list Iteml of list Item2 of list mH WF fi Bo He jH will produce 1 ltem1 of list 1 2 ltem2 of list 1 1 Item1 of list 2 2 ltem2 of list 2 Historically doxygen has an additional way to create numbered lists by using markers iteml item2 5 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 itemi x item2 When you remove the leading s doxygen 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 5 3 8 Limits on markup scope To avoid that a stray x 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 5 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 pr
254. nguage will be on Rebuild doxygen and doxywizard now 6 Now you can use OUTPUT_LANGUAGE your_language_name in the config file to generate output in your language 7 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 You can also clone the doxygen repository at GitHub and make a Pull Request later Generated by Doxygen 206 Internationalization 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 implem
255. nt 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 Generated by Doxygen 23 29 package lt name gt 145 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 y public void drawRect int int int int void drawRect const Rect amp r void Test drawRect int x int y int w int h void Test drawRect const Rect amp r This command draws a rectangle with a left upper corner at x 23 29 Indicates that a comment block contains documentation for a Java package with name lt name gt 23 30 class Test brief A short description More text fn void Test drawRect int x int y int w int h width a w and height la h 4 overload void Test drawRect const Rect amp r package lt name gt 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 documen
256. nt using DOT_FONTNAME you can set the path where dot can find it using this tag This tag requires that the tag HAVE_DOT is set to YES CLASS_GRAPH Ifthe CLASS_GRAPH tag is setto YES t hen 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_Dl AGRAMS tag to NO The default value is YES This tag requires that the tag HAVE_DOT is set to YES COLLABORATION_GRAPH If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a graph for each documented class showing the direct and indirect implementation dependencies inheritance containment and class references variables of the class with other documented classes The default value is YES This tag requires that the tag HAVE_DOT is set to Y GROUP_GRAPHS Gl S If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for groups show ing the direct groups dependencies The default value is YES This tag requires that the tag HAVE_DOT is set to Y EX S UML_LOOK If the UML_LOOK tag is set to YES doxygen will generate inheritance and collaboration diagrams in UML_LIMIT_NUM_FIELDS TEMPLATE_RELATIONS INCLUDE_GRAPH a style similar to the OMG s Unified Modeling Language The default value is NO This tag requires that the tag HAVE_DOT is set to YES If the UML_LOO
257. ntify the documentation publisher This should be a reverse domain name style string e g com mycompany MyDocSet documentation The default value is org doxygen Publisher This tag requires that the tag GENERATE _DOCSET is set to Y E un Generated by Doxygen 22 8 Configuration options related to the HTML output 119 DOCSET_PUBLISHER_NAME The DOCS ET PUBLISHER_NAME tag identifies the documentation publisher The default value is Publisher This tag requires that the tag GENERATE_DOCSET is set to YES 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 h1p 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 The default value is NO This tag requires that the tag GENERATE_HTML is set to YES CHM_FILE The CHM_FIL E tag can be used to spe
258. nts mouse events 1 mouse move event 2 mouse click event More info about the click event 3 mouse double click event e keyboard events 1 key down event 2 key up event More text here If you use tabs for indentation within lists please make sure that TAB_SIZE in the configuration file is set to the correct tab size 42 Lists You can end a list by starting a new paragraph or by putting a dot on an empty line at the same indentation level as the list you would like to end Here is an example that speaks for itself kx Text before the list x list item 1 sub item 1 sub sub item 1 sub sub item 2 The dot above ends the sub sub item list More text for the first sub item A AX A F F The dot above ends the first sub item More text for the first list item sub item 2 sub item 3 list item 2 A XA A A F More text in the same paragraph More text in a new paragraph RA A Using HTML commands If you like you can also use HTML commands inside the documentation blocks Here is the above example with HTML commands A list of events lt ul gt lt li gt mouse events lt ol gt lt li gt mouse move event lt li gt mouse click event lt br gt More info about the click event lt li gt mouse double click event lt ol gt lt li gt keyboard events lt ol gt lt li gt key down event lt li gt key up event lt ol gt
259. ode and files with extension f are interpreted as free format Fortran code For Fortran gt or lt starts a comment and or gt can be used to continue an 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 11 method param aggr information about the aggregates 1 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 f end subroutine As an 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 function A 4 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
260. om 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 Generated by Doxygen 38 Markdown 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 Ie 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 5 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 Furthermore a x or _ only starts an emphasis if e it is followed by an alphanumerical character and e it is preced
261. ommand the function is represented 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 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 23 25 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 23 26 namespace lt name gt Indicates that a comment block contains documentation for a namespace with name lt name gt 23 27 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 23 28 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 located in fro
262. on Doxygen specifics discusses some specifics for doxygen s implementation of the Markdown standard 5 1 Standard Markdown 5 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 5 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 a level 1 header A header is followed by a line containing only s or s Note that the exact amount of s or s is not important as long as there are at least two 32 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 5 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
263. ook as follows dummy Whats 21795 MEI ESE 520i count 20 page 1 pages 9 query List items TE The fields have the following meaning Generated by Doxygen 72 Searching hits the total number of search results could be more than was requested e first the index of first result returned min n p hits e count the actual number of results returned min n hits first page the page number of the result p hits pages the total number of pages e items an array containing the search data per result Here is an example of how the element of the items array should look like type function name QDir entryInfoList const QString amp nameFilter int filterSpec DefaultFilter int sortSpec DefaultSor tag qtools tag url d5 d8d class_q_dir html a9439ea6b331957 38dbad981c4d050ef fragments Returns a lt span class h1 gt list lt span gt of QFileInfo objects for all files and directories pointer to a QFileInfoList The lt span class hl1 gt list lt span gt is owned by the QDir object to keep the entries of the lt span class h1l gt list lt span gt after a subsequent call to this E The fields for such an item have the following meaning e type the type of the item as found in the field with name type in the raw search data name the name of the item including the parameter list as found in the fi
264. opied 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 This tag requires that the tag GENERATE_HTML is set to YES HTML FOOTER The HTML_FOOTER tag can be used to specify a user defined HTML footer for each generated 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 This tag requires that the tag GENERATE_HTML is set to YES HTML STYLESHEET The HTML_STYLESHEET 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 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 Generated by Doxygen 22 8 Configuration options related to the HTML output 117 HTML EXTRA STYLESHEET The HTML _EXTRA_STYLESH Note It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag as it is more robust and this tag HTML_STYLESHEET will in the future become obsolete T This tag r
265. ormulas 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 9 Graphs and diagrams Doxygen has built in support to generate inheritance diagrams for C classes Doxygen can use the 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
266. ou can use inside your custom header 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 14 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 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
267. oup in which they are included e g using ingroup instead of on a separate page for HTML and Man pages or section for ATEX and RTF Note that this feature does not work in combination with SEPARATE_MEMBER_PAGES The default value is NO INLINE_SIMPLE_STRUCTS When the INLINE_SIMPLE_STRUCTS tag is set to YES structs classes and unions with only public data fields or simple typedef fields will be shown inline in the documentation of the scope in which they are defined i e file namespace or group documentation provided this scope is docu mented If set to NO structs classes and unions are shown on a separate page for HTML and Man pages or section for ATEX and RTF The default value is NO TYPEDEF_HIDES_STRUCT When TYPEDEF_HIDES_STRUCT tag 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 The default value is NO LOOKUP_CACHE_SIZE The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE This cache is used to resolv
268. oupled to a certain class It only works for functions 23 43 relatedalso lt name gt Equivalent to relatesalso 23 44 showinitializer By default the value of a define and the initializer of a variable are only displayed if they are less than 30 lines 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_INITIALIZ ER_LINES the default value is 30 Generated by Doxygen 23 45 static 149 See also section hideinitializer 23 45 static Indicates that the member documented by the comment block is static i e it works on a class instead of on an instance of the class This command is intended for use only when the language does not support the concept of static methods natively e g C 23 46 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 23 47 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 Y n property and War See also section fn property and War 23 48 union lt name gt lt header file gt lt heade
269. ource browser e a class diagram generator computing code metrics Generated by Doxygen 198 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 script 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 s LEX i P a zA Z YY t file LEX d 1 P 2YY t S file g print Enabling debug info for file n elsif s LEX d i P a zA Z YY t file LEX 11 P12YY t file g print Disabling debug info for file n print G S_
270. ow TE eS 23 172 en ee ee A e are 23 173 Med A ds ok id as 23 174 O eas Goce Ed Bs aro ects Bk whan te ue lesbo dc od 23 175 O ee Red Suk Gt doa Bok exes deck ee o ae Bm 23 176 The following subsections provide a list of all commands that are recognized by doxygen Unrecognized commands are treated as normal text Structural indicators 23 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 Generated by Doxygen 23 3 callgraph 137 The title is optional so this command can also be used to add a number of entities to an existing group using and GQ like this addtogroup mygrp Additional documentation for group mygrp x Q A function void func1 Another function void func2 x See also page Grouping sections defgroup ingroup and weakgroup 23 3 callgraph 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 call graph for that function provided the implementation of the function or method calls other documented functions The call graph will be generated regardless of the value of CALL_GRAPH Note The completeness and corre
271. ow and its call was replaced by trFile true false in the doxygen source files Probably 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 has 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 newtrFile 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 trF ile is used with different arguments the English result is returned and it will be noticed by non
272. r 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 YAO BWNE Generated by Doxygen 4 1 Special comment blocks 27 8 9 DIDTABWNEO More details def func pass Documentation for a class More details class PyClass The constructor def __init__ self self _memVar 0 Documentation for a method param self The object pointer 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 YES in the config file 4 1 3 Comment blocks in VHDL For VHDL a comment normally start with 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 Here is an example VHDL file with doxygen comments D CoNo 0 J
273. r 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 23 49 var variable declaration Indicates that a comment block contains documentation for a variable or enum value either global or as a member of a class This command is equivalent to fn property and typedef See also section fn property and typedef 23 50 vhdlflow title for the flow chart This is a VHDL specific command which can be put in the documentation of a process to produce a flow chart of the logic in the process Optionally a title for the flow chart can be given Generated by Doxygen 150 Special Commands Note Currently the flow chart will only appear in the HTML output 23 51 weakgroup 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 23 52 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 att ent ion commands will be joined into a single paragraph The attention command ends when a blank line or
274. r that indicates the origin of the item 23 92 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 23 93 warning warning message 159 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 23 93 warning warning message 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 description 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 23 94 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 te
275. racter has to be escaped in some cases because it is used for Markdown tables 23 175 This command writes two dashes to the output This allows writing two consecutive dashes to the output instead of one n dash character 23 176 This command writes three dashes to the output This allows writing three consecutuve dashes to the output instead of one m dash character 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 annotatedclasslist classhierarchy define functionindex header headerfilelist inherit eN Generated by Doxygen 23 176 179 postheader Generated by Doxygen 180 Special Commands Generated by Doxygen Chapter 24 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 HR EF and NAMI E attributes for the A tag are the only exception lt A HREF gt Starts a hyperlink if supported by the output format lt A NAME gt Starts a named anchor if supported by the output format lt A gt Ends a link or anchor lt B gt Starts a piece of text displ
276. 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 e 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 converted 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 pu
277. reek capital letter pi II greek capital letter rho P greek capital letter sigma Y greek capital letter tau T greek capital letter upsilon Y greek capital letter phi greek capital letter chi X greek capital letter psi Y greek capital letter omega Q Generated by Doxygen 187 salpha beta gamma delta sepsilon amp zeta amp eta amp theta amp iota amp kappa amp lambda amp mu amp nu amp X1 gomicron amp pi amp rho amp sigmaf amp sigma amp tau upsilon amp phi amp chi amp psi amp omega amp thetasym amp upsih amp piv amp bull amp hellip amp prime amp Prime amp oline amp frasl amp weierp amp image greek small letter alpha a greek small letter beta greek small letter gamma y greek small letter delta 6 greek small letter epsilon e greek small letter zeta greek small letter eta n greek small letter theta 0 greek small letter iota 1 greek small letter kappa k greek small letter lambda A greek small letter mu u greek small letter nu v greek small letter xi greek small letter omicron o greek small letter pi 7 greek small letter rho p greek small letter final sigma greek small letter sigma o greek small letter tau 7 greek small letter upsilon V greek small letter phi greek small letter chi x greek small letter psi y greek small letter omega greek sm
278. rgument 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 Generated by Doxygen 23 109 paragraph lt paragraph name gt paragraph title 163 See also Section page for an example of the section command and subsection command 23 109 paragraph 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 23 110 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 documen tation 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 dont include 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 un
279. rings 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 Sdoxydocs does not present any special impediment to be processed by a simple Perl script 27 4 Data structure You might be interested in processing the documentation contained in DoxyDocs pm without needing to take into account 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
280. rk 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 are 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 cla
281. rrounding 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 used 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 23 112 includelineno lt file name gt This command works the same way as include but will add line numbers to the included file See also section include 23 113 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 found See section dontinclude for an example 23 114 skip pattern This command searches line by line through the example that was last included us
282. s 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 asterisks _single underscores_ double asterisksxx double underscores See section Emphasis limits for more info how doxygen handles emphasis spans slightly different than standard Markdown 5 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 To assign the output of command ls to var use var 1s See section Code Spans Limits for more info how doxygen handles code spans slightly different than standard Markdown 5 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 5 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
283. s Arabic Armenian Brazilian Catalan Chinese Chinese Traditional Croatian Czech Danish Dutch English United States Esperanto Farsi Persian Finnish French German Greek Hungarian Indonesian Italian Japanese Japanese en Japanese with English messages Korean Korean en Korean with English messages Latvian Lithuanian Macedonian Norwegian Persian Farsi Polish Portuguese Romanian Russian Serbian Serbian Cyrillic Slovak Slovene Spanish Swedish Turkish Ukrainian and Vietnamese The default value is English BRIEF_MEMBER_DESC If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member descriptions after the members that are listed in the file and class documentation similar to Javadoc Set to NO to disable this The default value is YES REPEAT_BRIEF Ifthe REPEAT_BRIEF tag is set to YES doxygen will prepend the brief description of a member or function before the detailed description Note If both HIDE UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO the brief descriptions will be completely suppressed The default value is YES 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
284. s Y SHOW_FILES Setthe SHOW_FIL ES 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 Gl The default value is YES SHOW_NAMESPACES Set the SHOW_NAM ESPAC ES 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 value is Y Gl S FILE_VERSION_FILTER The FIL doxygen should invoke to get F _VERSION_FILTER tag can be used to specify a program or script that 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 FIL input file provided by doxygen Example of using a shell script F VERSION_FILTER tag and input file is the name of an Whatever the program writes to standard output is used as the file version as a filter for Unix FILE_VERSION_FILTER bin sh versionfilter sh Generated by Doxygen 22 4 Configuration options related to warning and progress messages 111 Example shell 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 s
285. s 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 23 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 Generated by Doxygen 23 15 fn function declaration 141 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 A more elaborated file description kk 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 23 15 fn function declaration Indicates that a comment block contains documentation for a function 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 d
286. s 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 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 equivalent to doing brief details See copybrief and copydetails for copying only the brief or detailed part of the comment block 23 127 copybrief lt link object gt Works in a similar way as copydoc but will only copy the brief description not the detailed documentation 23 128 copydetails lt link object gt Works in a similar way as copydoc but will only copy the detailed documentation not the brief description 23 129 docbookonly Starts a block of text that will be verbatim included in the generated docbook documentation only The block ends with a enddocbookonly command Generated by Doxygen 23 130 dot 169 See also section manonly latexonly rtfon
287. s chose the most radical one When the update takes much more time than you expected you can always decide 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 Translatore 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 Your translator is marked as up to date only if the script does not detect anything special If the translator uses the Translator base class there still may be some remarks related to your source code In the case the translator is
288. s look prettier in the HTML out put When enabled you may also need to install MathJax separately and configure the path to it using the MATHJAX_RELPATH option The default value is NO This tag requires that the tag GENERATE_HTML is set to Y GI S MATHJAX_FORMAT When MathJax is enabled you can set the default output format to be used for the MathJax output See the MathJax site for more details Possible values are HTML CSS which is slower but has the best compatibility Nat iveMML i e MathML and SVG The default value is HTML CSS This tag requires that the tag USE_MATHJAX is set to YES 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 math jax 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 strongly recommended to install a local copy of MathJax from http www mathjax org before deployment Generated by Doxygen 122 Configuration The default value is http cdn mathjax org mathjax latest This tag requires that the tag USE_MATHJAX is set to YES MATHJAX_EXTENSIONS The MATHJAX_EXTENSIONS tag can be used to
289. s not contain any spaces The quotes are stripped before the caption is displayed 23 133 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 23 134 diafile lt file gt caption Inserts an image made in dia from lt file gt into the documentation 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 DIAFILE_DIRS tag If the dia file is found it will be used as an input file dia The resulting image will be put into the correct output directory If the dia file name contains spaces you ll have to put quotes around it The second argument is optional and can be used to sp
290. s or markers available This tag requires that the tag GENERATE_HTML is set to YES Ea _HUE tag controls the color of the HTML output Doxygen will adjust 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 Minimum value 0 maximum value 35 9 default value 220 This tag requires that the tag GENERATE_HTML is set to YES HTML _COLORSTYLE_SAT The HTML_COLORSTYLE_SAT tag controls the purity or saturation of the colors T 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 Minimum value 0 maximum value 255 default value 100 This tag requires that the tag GENERATE_HTML is set to Y E S Generated by Doxygen 118 Configuration 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 Minimum value 40 maximum
291. s tailored for Fortran The default value is NO 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 The default value is NO 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 fixed format Fortran FortranFixed free formatted Fortran FortranFree unknown formatted Fortran Fortran In the later case the parser tries to guess whether the code is fixed or free formatted code this is the default for Fortran type files 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 Note For files without extension you can use no_extension as a placeholder Note that for custom extensions you also need to set FILE PATTERNS otherwise the files are not read by doxygen MARKDOWN_SUPPORT If the MARKDOWN_SUPPORT tag is enabled then doxygen pre processes all com ments according to the Markdown format which allows for more readable documentation See ht
292. s with their definition in the source code All source code fragments are syntax highlighted for ease of reading 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
293. sers dimitri doxygen mail 1 3 7 autolink Doxyfile Reset Users dimitri doxygen examples author cfg Users dimitri doxygen examples autolink cfg Users dimitri doxygen examples diagrams cfg Users dimitri doxygen Doxyfile Figure 21 7 File menu Open This is the same as the Load button in the main window 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 22 Configuration 22 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 It is 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 beginning with two hash characters are kept when updating the configuration file and are placed in front of the TAG are in front of Comments beginning with two hash characters at the en
294. 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 in the HEAD section of the HTML page Generated by Doxygen 85 10 11 12 13 14 15 16 17 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 QFilelnfo 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 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
295. 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 structural 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 4 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 1 package docstring 2 Documentation for this module 3 4 More details 5 num 6 7 def func 8 Documentation for a function 9 0 More details 1 nw 2 pass 3 4 class PyClass 5 Documentation for a class 6 7 More details 8 nu 9 20 def _ init_ self 21 e The constructor 22 self _memVar 0 23 24 def PyMethod self 25 Documentation for a method 26 pass 27 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 othe
296. ss A has a member variable m of type C where B is a subtype of C e g C could be B Bk T lt B gt x 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 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 fendif 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 10 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 1 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 stati
297. start 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 13 1 External Indexing and Searching 13 1 1 Introduction With release 1 8 3 doxygen provides the ability to search through HTML using an external indexing tool and search engine This has several advantages e For large projects it can have significant performance advantages over doxygen s built in search engine as doxygen uses a rather simple indexing algorithm It allows combining the search data of multiple projects into one index allowing a global search across multiple doxygen projects e It allows adding additional data to the search index i e other web pages not produced by doxygen The search engine needs to run on a web server but clients can still browse the web pages locally To avoid that everyone has to start writing their own indexer and search engine doxygen provides an example tool for each action doxyindexer for indexing the data and doxysearch cgi for searching through the index The data flow is shown in the following diagram Generated by Doxygen 68 Searching doxygen writes searchdata xml i reads doxyindexer Q writes doxysearch db i reads doxysearch cgi HTML page in browser Figure 13 1 External Search Data Flow doxygen produces the
298. stconditions The post command ends when a blank line or some other sectioning command is encountered 23 77 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 23 78 remark remark text 157 23 78 remark remark 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 23 79 remarks remark text Equivalent to remark 23 80 result description of the result value Equivalent to return 23 81 return description of the return value Starts a return value description for a
299. t argument should be a single word identifier See also page Grouping sections ingroup addtogroup and weakgroup 23 9 1 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 STRIP_FROM_PATH option determines what is stripped from the full path before it appears in the output 23 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 x Another enum with inline docs x enum AnotherEnum vl lt value 1 x V2 x lt value 2 y y x class Test The class description Nenum Test TEnum x A description of the enum type var Test TEnum Test Vall x The description of the first enum value 23 11 example lt file name gt Indicates that a comment block contains documentation for a source code exa
300. t 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 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 11 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 Exa
301. t 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 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 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 Generated by Doxygen 116 Configuration 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 H
302. t 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 like environment cat Doxyfile echo PROJECT_NUMBER 1 0 doxygen For Windows the following would do the same Generated by Doxygen 86 Frequently Asked Questions type Doxyfile amp echo PROJECT_NUMBER 1 0 doxygen exe If multiple options with the same name are specified then doxygen will use the 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
303. t you must put the section label after the ENABLED_SECTIONS tag in the configuration file The section label can be a logical expression build of section names round brackets amp amp AND OR and NOT See also sections endif if else and elseif and ENABLED_SECTIONS 23 69 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 23 70 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 Generated by Doxygen 23 71 par paragraph title paragraph 155
304. t_B Doxyfile EXTERNAL_SEARCH_ID B EXTRA_SEARCH_MAPPINGS Il D Il project_A html with these settings projects A and B can share the same search database and the search results will link to the right documentation set 13 1 3 Updating the index When you modify the source code you should re run doxygen to get up to date documentation again When using external searching you also need to update the search index by re running doxyindexer You could wrap the call to doxygen and doxyindexer together in a script to make this process easier 13 1 4 Programming interface Previous sections have assumed you use the tools doxyindexer and doxysearch cqgi to do the indexing and searching but you could also write your own index and search tools if you like For this 3 interfaces are important The format of the input for the index tool The format of the input for the search engine The format of the output of search engine The next subsections describe these interfaces in more detail 13 1 4 1 Indexer input format The search data produced by doxygen follows the Solr XML index message format The input for the indexer is an XML file which consists of one lt add gt tag containing multiple lt doc gt tags which in turn contain multiple lt field gt tags Here is an example of one doc node which contains the search data and meta data for one method lt add gt lt doc gt lt field name type gt function lt fie
305. tation The 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 Generated by Doxygen 146 Special Commands 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 23 31 private Indicates that the member documented by the comment block is private i 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 PH
306. ted 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 To enable this set both SEARCHENGINE and SERVER_BASED_SEARCH to YES in the config file and set EXT ERNAL_SEARCH to NO Advantages over the client side search engine are that it provides full text search and it scales well to medium side projects Disadvantages are that it does not work locally i e using a file URL and that it does not provide live search capabilities 66 Searching Note In the future this option will probably be replaced by the next search option 3 Server side searching with external indexing With release 1 8 3 of doxygen another server based search option has been added With this option doxygen generates the raw data that can be searched and leaves it up to external tools to do the indexing and searching meaning that you could use your own indexer and search engine of choice To make life easier doxygen ships with an example indexer doxyindexer and search engine doxysearch cgi based on the Xapian open source search engine library To enabl
307. 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 an example that uses doxygen XML output from Python to bridge it with the Sphinx document generator Generated by Doxygen Chapter 15 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 15 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 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
308. the generated files may appear in English Once the oldest adapter class is not used by any of the language 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 First 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 alway
309. 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 sourceforge net projects qdbttabular but hasn t been updated since 2002 Qt had nicely generated doc umentation 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 18 Troubleshooting 18 1 Known Problems If you have problems building doxygen from sources please read this section first Doxygen is nota real compiler it is only a lexical scanner This means that it can and will not detect errors in your source code Doxygen has a build in preprocessor but this works slightly different than the C preprocessor Doxygen assumes a header file is properly guarded against multiple inclusion and that each include file is standalone i e it could be placed at the top of a source file without causing compiler errors As long as this is true and this is a good design practice you should not encounter problems Since it is impossible to test all possibl
310. til commands An internal pointer is used for these commands The dont include command sets the pointer to the first line of the example Example A test class x class Test public a member function void example y x page example x dontinclude example_test cpp Our main function starts like this x skip main x until First we create an object c t of the Test class x Askipline Test Then we call the example member function x line example After that our little test routine ends x NMline 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 Generated by Doxygen 164 Special Commands See also sections line skip skipline until and include 23 111 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 su
311. tion options 103 OUTPUT _DIRECTORY 2 22 2 SHOW_INCLUDE_FILES 22 3 OUTPUT LANGUAGE 0 0500 00055 22 2 SHOW_NAMESPACES ans PAPER TYPE 0000 eee eeee 22 9 SHOW_USED FILES 0 22 3 PDF_HYPERLINKS 0 000 22 9 SIP SUPPORT a arch cect iain adela 22 2 PERLMOD LATEX eo vican Sue dee da an 22 15 SKIP_FUNCTION MACROS 22 16 PERLMOD_MAKEVAR_PREFIX 22 15 SORT_BRIEF_DOCS 00 223 PERLMOD PRETTY lt o scere a pene oe ee eed 22 15 SORT_BY_SCOPE_NAME 223 PERL_PATH eee ee es 22 17 SORT_GROUP_NAMES 05 22 3 PREDEFINED ooo 22 16 SORT_MEMBERS_CTORS_1ST 22 3 PROJECT BRIEF 24 os care Seb eek ee EY we 22 2 SORT_MEMBER_ DOCS 223 PROJECT LOGO 1 eee eee 22 2 SOURCE BROWSER ooo 22 6 PROJECT_NAME E O ee 22 2 SOURCE_TOOLTIPS A a de a E Ge a AA 22 6 II a e aE es STRICT_PROTO_MATCHING 22 3 QCH FILE occ 22 8 STRIP_CODE_COMMENTS 22 6 GHG LOCATION o ooo 440 cir aed 22 8 STRIP FROM INC PATH pa QHP_CUST FILTER_ATTRS 22 8 STRIP FROM_PATH 0 pe E ETER AME sos EA Pan SUBGROUPING o oaaao a aaa aaa aaua 22 2 dg nd calcio a eens TAB SIZE ccc ran 22 2 QHP_VIRTUAL_FOLDER 22 8 TOUP e Pia ark he Sees e ees QT_AUTOBRIEF 0 0 eee 22 2 PO sh g o atn a ea
312. tional code fragments and to allow expansion of all or part of macros definitions Automatically detects public 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 92 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 entitie
313. to members or classes belonging to the Qt toolkit a link will be generated to the Qt documentation This is done independent of where this documentation is located Generated by Doxygen Chapter 20 Doxygen usage Doxygen is a command line based utility Calling doxygen with the he 1p 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 t
314. tp daringfireball net projects markdown for details The output of markdown processing is further processed by doxygen so you can mix doxygen HTML and XML commands with Markdown for matting Disable only in case of backward compatibilities issues The default value is YES AUTOLINK_SUPPORT When enabled doxygen tries to link words that correspond to documented classes or namespaces to their corresponding documentation Such a link can be prevented in individual cases by by putting a sign in front of the word or globally by setting AUTOLINK_SUPPORT to NO S Gl The default value is Y 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 doxy gen match functions declarations and definitions whose arguments contain STL classes e g func std istring versus func std string This also make the inheritance and collaboration dia grams that involve STL classes more complete and accurate The default value is NO CPP_CLI_SUPPORT If you use Microsoft s C CLI language you should set this option to YES to enable pars ing support The default value is NO Generated by Doxygen 22 3 Build related configuration options 107 SIP_SUPPORT Set the SIP_SUPPORT tag to YES if your project consists of sip sources only Doxygen will parse them li
315. ty of this option depends on whether or not doxygen was compiled with the with libclang option The default value is NO CLANG_OPTIONS If clang assisted parsing is enabled you can provide the compiler with command line options that you would normally use when invoking the compiler Note that the include paths will already be set by doxygen for the files and directories specified with INPUT and INCLUDE_PATH This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES Generated by Doxygen 22 7 Configuration options related to the alphabetical class index 115 22 7 Configuration options related to the alphabetical class index ALPHABETICAL INDEX If the ALPHABETICAL_INDExX 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 The default value is YES COLS_IN_ALPHA INDEX The COLS_IN_ALPHA_INDExX tag can be used to specify the number of columns in which the alphabetical index list will be split Minimum value 1 maximum value 20 default value 5 This tag requires that the tag ALPHABETICAL_INDEX is set to YES 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 headers
316. ue of OUTPUT_DIRECTORY will be put in front of it The default directory is docbook This tag requires that the tag GENERATE_DOCBOOK is set to YES 22 14 Configuration options for the AutoGen Definitions output 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 The default value is NO 22 15 Configuration options related to the Perl module output 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 still experimental and incomplete at the moment The default value is NO PERLMOD_LATEX If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary Makefile rules Perl scripts and IATEX code to be able to generate PDF and DVI output from the Perl module output The default value is NO This tag requires that the tag GENERATE_PERLMOD is set to YES 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 N
317. ure 3 1 Doxygen information flow 14 Getting Started 3 1 Step 0 Check 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 3 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 configuratio
318. use the code parser isn t smart enough at the moment I ll try to improve this in the future But even with 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 88 Troubleshooting 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 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 Not all special commands are properly translated to RTF 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 18 2 Howto 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 18 3 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 wil
319. ve Uacute latin capital letter U with acute U e Ucirc latin capital letter U with circumflex U Uuml latin capital letter U with diaeresis U amp Yacute latin capital letter Y with acute Y amp THORN latin capital letter THORN P e szlig latin small letter sharp s ess zed B e Sagrave latin small letter a with grave latin small letter a grave a Saacute latin small letter a with acute a e amp acirc latin small letter a with circumflex a amp atilde latin small letter a with tilde a gauml latin small letter a with diaeresis a e Saring latin small letter a with ring above latin small letter a ring a e aelig latin small letter ae latin small ligature ae amp ccedil latin small letter c with cedilla e egrave latin small letter e with grave geacute latin small letter e with acute gecirc latin small letter e with circumflex geuml latin small letter e with diaeresis e amp igrave latin small letter i with grave i amp lacute latin small letter i with acute e amp icirc latin small letter i with circumflex 7 amp iuml latin small letter i with diaeresis seth latin small letter eth 6 amp ntilde latin small letter n with tilde A e Ograve latin small letter o with grave oacute latin small letter o with acute 6 OCirc latin small letter o with circumflex 6 Generated by Doxygen 186 H
320. w 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 The default value is YES This tag requires that the tag HAVE_DOT is set to YES DOT_IMAGE_FORMAT The DOT_IMAGE_FORMAT tag can be used to set the image format of the images gen erated by dot Note If you choose svg you need to set HTML_FILE_EXTENSION to xhtm1 in order to make the SVG files visible in IE 9 other browsers do not have this requirement Possible values are png jpg gif and svg The default value is png This tag requires that the tag HAVE_DOT is set to YES INTERACTIVE_SVG If DOT_IMAGE_FORMAT is set to svg then this option can be set to YES to enable generation 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 The default value is NO This tag requires that the tag HAVE_DOT is set to YES DOT_PATH The DOT_PATH 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 in the path This tag requires that the tag HAVE_DOT is set to Y El un Generat
321. width should not exceed 200 pixels Doxygen will copy the logo to the output directory Generated by Doxygen 104 Configuration 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 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 The default value is NO ALLOW_UNICODE_NAMES If the ALLOW_UNICODE_NAMES tag is set to YES doxygen will allow non ASCII characters to appear in the names of generated files If set to NO non ASCII characters will be escaped for example _xE3_x81_ x84 will be used for Unicode U 3044 The default value is NO OUTPUT_LANGUAGE The OUTPUT_LANGUAGE tag is used to specify the language in which all documentation generated by doxygen is written Doxygen will use this information to generate all constant output in the proper language Possible values are Afrikaan
322. xamples 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 tools 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 2 3 Known compilation problems for UNIX 9 2 3 Known compilation problems for UNIX Qt problems The Qt include files and libraries are not a subdirectory of the directory pointed to by OTDIR on some systems for instance on Red Hat 6 0 includes are in usr include qt and libs are in usr 11b The solution go to the root of the doxygen distribution and do mkdir qt cd qt in s your qt include dir here include ln 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 S PWD instead of the export command above Now install doxygen as described above Bison problems Versions 1 31 to 1 34 of bison contain a
323. xt 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 seen 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 In case parameter heading is the empty string no heading is generated This can be useful when used in combination with the page command e g xx page my_errors My Errors bri
324. yle 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 file 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 21 Doxywizard usage Doxywizard is a GUI front end for configuring and running doxygen Note it is possible to start the doxywizard with as argument the configuration file to be used When you start doxywizard it will display the main window the actual look depends on the OS used 606 Doxygen GUI frontend Step 1 Configure doxygen Choose one of the following ways to configure doxygen Step 2 Save the configuration file Status not saved Step 3 Specify the directory from which to run doxygen Working directory Users dimitri doxygen Step 4 Run doxygen Start Status not running Save log Output produced by doxygen Figure 21 1 Main window The windows shows the steps to take

manual is provided

Contents

Download Pdf Manuals

Related Search

Related Contents