@@ -111,7 +111,7 @@ Within doxygen there are a number of ways to obtain debug output. Besides the
111111invasive method of putting print statements in the code there are a number of
112112easier ways to get debug information.
113113
114- For a debug build (build option ` -DCMAKE_BUILD_TYPE=Debug ` )
114+ For a debug build (build option ` -DCMAKE_BUILD_TYPE=% Debug ` )
115115these options are always available, but for a release build some debug capabilities have to be enabled explicitly
116116(see build options ` -Denable_tracing=YES ` and ` -Denable_lex_debug=YES ` ).
117117
@@ -123,61 +123,67 @@ which can be used (by experts) to diagnose problems.
123123During a run of doxygen it is possible to specify the ` -d ` command line option with one of the
124124following values (each option has to be preceded by ` -d ` ):
125125
126- - preprocessor<br >
126+ - ` preprocessor ` <br >
127127 Shows the results of the preprocessing phase, i.e. results from include files,
128128 <tt >\# define</tt > statements etc., definitions in the doxygen configuration file like:
129129 ` EXPAND_ONLY_PREDEF ` , ` PREDEFINED ` and ` MACRO_EXPANSION ` .
130- - nolineno<br >
130+ - ` nolineno ` <br >
131131 In case the line numbers in the results of the preprocessing phase are not wanted they
132132 can be removed by means of this option (without ` -d preprocessor ` this option has no effect.
133- - commentcnv<br >
133+ - ` commentcnv ` <br >
134134 Shows the results of the comment conversion, the comment conversion does the
135135 following:
136136 - It converts multi-line C++ style comment blocks (that are aligned)
137137 to C style comment blocks (if ` MULTILINE_CPP_IS_BRIEF ` is set to ` NO ` ).
138138 - It replaces aliases with their definition (see ` ALIASES ` )
139139 - It handles conditional sections (<tt >\\ cond ... \\ endcond</tt > blocks)
140- - commentscan<br >
140+ - ` commentscan ` <br >
141141 Will print each comment block before and after the comment is interpreted by
142142 the comment scanner.
143- - printtree<br >
143+ - ` printtree ` <br >
144144 Give the results in pretty print way, i.e. in an XML like way with each
145145 level indented by a ` "." ` (dot).
146- - time<br >
146+ - ` time ` <br >
147147 Provides information of the different stages of the doxygen process.
148- - extcmd<br >
148+ - ` extcmd ` <br >
149149 Shows which external commands are executed and which pipes are opened.
150- - markdown<br >
150+ - ` markdown ` <br >
151151 Will print each comment block before and after Markdown processing.
152- - filteroutput<br >
152+ - ` filteroutput ` <br >
153153 Gives the output of the output as result of the filter command (when a filter
154154 command is specified)
155- - validate<br >
156- Currently not used
157- - cite<br >
155+ - ` cite ` <br >
158156 Retains the temporary files as created and used for the non LaTeX output results of the
159157 generation of the bibliographical references.
160- - fortranfixed2free<br >
158+ - ` fortranfixed2free ` <br >
161159 Shows the result of the conversion of Fortran fixed formatted files to Fortran free formatted
162160 files as done by doxygen.
163- - plantuml<br >
161+ - ` plantuml ` <br >
164162 Shows information about the plantuml process run and the used input / output filenames, the content of the
165163 input file.
166- - rtf<br >
164+ - ` rtf ` <br >
167165 - Shows the original names and the anchors names (called bookmarks in RTF) where they are mapped to.
168166 - At the end of the generation of the RTF files these files are merged into one large RTF file, with
169167 this option the original files are retained.
170- - qhp<br >
168+ - ` qhp ` <br >
171169 - The qhp file is created with indentation for better readability (normally no indentation so the file is smaller).
172170 - When the setting ` QHG_LOCATION ` is pointing to the ` qhelpgenerator ` besides generating the ` qch ` file
173171 also some extra checks are done by means of the ` -c ` flag of the ` qhelpgenerator ` .
174- - tag<br >
172+ - ` tag ` <br >
175173 Shows the results of reading the tag files.
176- - lex<br >
174+ - ` alias ` <br >
175+ Show the results of the ` ALIASES ` resolving process
176+ - ` entries ` <br >
177+ Dump the tree of Entries as found by doxygen
178+ - ` formula ` <br >
179+ Don't remove the intermedate files generated by the creation of the images with the formulas.
180+ - ` sections ` <br >
181+ Show the sections as found by doxygen
182+ - ` lex ` <br >
177183 Provide output of the ` lex ` files used. When a lexer is started and when a lexer
178184 ends the name of the ` lex ` file is given so it is possible to see in which lexer the
179185 problem occurs. This makes it easier to select the file to be compiled in ` lex ` debug mode.
180- - lex: lexer <br >
186+ - ` lex:lexer ` <br >
181187 Enables output for a specific lexer only, where ` lexer ` should be replaced by the name of the specific lexer.
182188
183189Producing output
@@ -212,7 +218,7 @@ Documentation Topics TODO
212218 - via Graphviz dot
213219 - via mscgen
214220 - PNG generation
215- - Output formats: OutputGen , OutputList, and DocVisitor
221+ - Output formats: OutputGenerator , OutputList, and DocVisitor
216222 - Html: HtmlGenerator and HtmlDocVisitor
217223 - Latex: LatexGenerator and LatexDocVisitor
218224 - RTF: RTFGenerator and RTFDocVisitor
0 commit comments