This section covers frequently asked questions about DoxyPress.

How do I set up the index page?

Use the \mainpage command inside a comment block as follows:

/*! \mainpage My Index Page
 *
 * \section intro_sec Introduction
 *
 * This is the introduction for my application of project.
 *
 * \section install_sec Installation
 *
 * \subsection step1 Step 1: Opening the box
 *
 * etc...
 */

Why are some of the members of my class, file, or namespaces not documented?

Check the following:

Is your class, file, or namespace documented? If not, it will not be extracted from the sources unless extract-all is set to YES in the project file.
Are the members private? If so must set extract-private to YES to make them appear in the documentation.
Is there a macro in your class which does not end with a semicolon? If so then you have to instruct our preprocessor to remove it. This requires the following settings in your project file:
```
   ENABLE-PREPROCESSING    = YES
   MACRO-EXPANSION         = YES
   EXPAND-ONLY-PREDEFINED  = YES
   PREDEFINED-MACROS       = MY_MACRO()=
```

When I set "EXTRACT ALL" to NO, none of my functions are documented

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 cmdfile command.

Alternatively, you can put all members in a group (or module) using the cmdingroup command and then document the group using a comment block containing the cmddefgroup command.

For member functions or functions which are part of a namespace you should document either the class or namespace.

How can I make DoxyPress ignore code fragments?

Add a comment block with a cmdcond command at the start and a second comment block with a cmdendcond command at the end.

The DoxyPress preprocessor can also be used as follows:

#ifndef DOXYPRESS_SHOULD_SKIP_THIS

   /* code that must be skipped by DoxyPress */

#endif

You will also need to add the following to the predefined-macros tag in the project file.

PREDEFINED = DOXYPRESS_SHOULD_SKIP_THIS

How do I change the #include displayed in the class documentation?

Normally the strip-from-inc-path is used to strip off part of a path. You can also document your class similar to the following:

/*! \class MyClassName include.h path/include.h
 *
 *  Docs for MyClassName
 */

If you want DoxyPress to show the include file with quotes instead of angle brackets, document your class as follows:

/*! \class MyClassName include.h "path/include.h"
 *
 *  Docs for MyClassName
 */

How can I use tag files in combination with compressed HTML?

If you want to refer from one compressed HTML file called a.chm to another compressed HTML file called b.chm, the link in a.chm must have the following format:

   <a href="b.chm::/file.html">

The 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.

With project "A" referring to project "B" using tag file b.tag, rename the index.chm for project "A" to a.chm and the index.chm for project "B" to b.chm. In the project file for project "A" set the following:

   TAGFILES = b.tag=b.chm::

I am using my own HTML header and the HTML output looks incorrect

Verify you have included the stylesheet doxypress.css in your custom HTML header file.

<LINK HREF="doxypress.css" REL="stylesheet" TYPE="text/css">

How do I exclude all test directories from my directory tree?

Add an exclude pattern in your project file like the following:

EXCLUDE_PATTERNS = */test/*

DoxyPress automatically generates a link to the class MyClass. How do I prevent this?

Place a % in front of the class name. As an example: %MyClass. DoxyPress will remove the "%" and the word will be unlinked.

When running make in the latex directory I get "TeX capacity exceeded". What should I do?

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?

DoxyPress is unaware of the STL classes, unless the option built-in-stl-support is turned on.

I am having issues with the search engine not working with PHP 5 on Windows

Please review the documentation regarding Overview.