You should use the \ref cmdmainpage "\\mainpage" command inside a comment block like this: \verbatim /*! \mainpage My Personal Index Page * * \section intro_sec Introduction * * This is the introduction. * * \section install_sec Installation * * \subsection step1 Step 1: Opening the box * * etc... */ \endverbatim \section fac_al Help, some/all of the members of my class / file / namespace are not documented? Check the following:
\#include \
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:
\verbatim
/*! \class MyClassName myhdr.h "path/myhdr.h"
*
* Docs for MyClassName
*/
\endverbatim
\section faq_chm How can I use tag files in combination with compressed HTML?
If you want to refer from one compressed HTML file
\c a.chm to another compressed HTML file
called \c b.chm, the
link in \c a.chm must have the following format:
\verbatim
\endverbatim
Unfortunately this only works if both compressed HTML files are in the same
directory.
As a result you must rename the generated \c index.chm files for all projects
into something unique and put all .chm files in one directory.
Suppose you have a project \e a referring to a project \e b using tag file
\c b.tag, then you could rename the \c index.chm for project \e a into
\c a.chm and the \c index.chm for project \e b into \c b.chm. In the
configuration file for project \e a you write:
\verbatim
TAGFILES = b.tag=b.chm::
\endverbatim
\section faq_html I don't like the quick index that is put above each HTML page, what do I do?
You can disable the index by setting \ref cfg_disable_index "DISABLE_INDEX" to `YES`. Then you can
put in your own header file by writing your own header and feed that to
\ref cfg_html_header "HTML_HEADER".
\section faq_html_header The overall HTML output looks different, while I 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
\verbatim
\endverbatim
in the HEAD section of the HTML page.
\section faq_use_qt Why does doxygen use Qt?
In the past (prior to version 1.9.2) doxygen used a part of Qt 2.x for various
utility classes. These have been replaced by STL container classes in the meantime.
The GUI front-end called Doxywizard is based on a modern version of Qt.
Doxygen itself can also be used without the GUI.
\section faq_excl_dir How can I exclude all test directories from my directory tree?
Simply put an exclude pattern like this in the configuration file:
\verbatim
EXCLUDE_PATTERNS = */test/*
\endverbatim
\section faq_class Doxygen automatically generates a link to the class MyClass somewhere in the running text. How do I 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.
\section faq_pgm_X My favorite programming language is X. Can I still use doxygen?
No, not as such; doxygen needs to understand the structure of what it reads.
If you don't mind spending some time on it, there are several options:
- If the grammar of X is close to C or C++, then it is probably not too hard to
tweak \c src/scanner.l 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 https://www.doxygen.org/download.html#helpers).
- If the grammar is completely different one could write a parser for X and
write a backend that produces a similar syntax tree as is done by
\c src/scanner.l (and also by \c src/tagreader.cpp while reading tag files).
\section faq_lex Help! I 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 characters in one go. I've seen this happening
on a very large generated file (\>256K lines), where the built-in preprocessor
converted it into an empty file (with \>256K of newlines). Another case
where this might happen is if you have lines in your code with more than
256K characters.
If you have run into such a case and want me to fix it, you
should send me a code fragment that triggers the message. To work around
the problem, put some line-breaks into your file, split it up into smaller
parts, or exclude it from the input using EXCLUDE.
Another way to work around this problem is to use the cmake command with the option:
```
-Denlarge_lex_buffers=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):
\verbatim
( cat Doxyfile ; echo "PROJECT_NUMBER=1.0" ) | doxygen -
\endverbatim
For Windows command line the following would do the same:
\verbatim
( type Doxyfile & echo PROJECT_NUMBER=1.0 ) | doxygen.exe -
\endverbatim
For Windows Powershell (checked with version 5.1) the following would do the same:
\verbatim
&{ type Doxyfile ; echo "PROJECT_NUMBER=1.0" } | doxygen -
\endverbatim
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.
\section faq_name How did doxygen get its name?
Doxygen got its name from playing with the words
documentation and generator.
\verbatim
documentation -> docs -> dox
generator -> gen
\endverbatim
At the time I was looking into \c lex and \c yacc, where a lot of things start with
"yy", so the "y" slipped in and made things pronounceable
(the proper pronouncement is Docs-ee-gen, so with a long "e").
\section faq_why What was the reason to develop doxygen?
I once wrote a GUI widget based on the Qt library (it is still available at
https://sourceforge.net/projects/qdbttabular/ but hasn't been updated since 2002).
Qt had nicely generated documentation (using an internal tool which
they didn't want to release)
and I wrote similar docs by hand.
This was a nightmare to maintain, so I wanted a similar tool. I 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 I had grown to like),
so I started to write my own tool...
\section faq_bin How to prevent interleaved output
When redirecting all the console output of doxygen, i.e. messages and warnings, this can be interleaved or
in a non-expected order.
The, technical, reason for this is that the `stdout` can be buffered.
It is possible to overcome this by means of the `-b` of doxygen, like e.g `doxygen -b > out.txt 2>&1`.
Note this might cost a little more time though.
\htmlonly
Go to the next section or return to the
index.
\endhtmlonly
*/