Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How to include folder in doxygen documentation?

I want to include folder in doxygen documentation.

I have tried \page and \include but it hasn't worked, does anyone know how to do it? Here is the tree :

+root
-+controllers
--- category.php
-+models
--- categories.php
- mainpage.php
like image 777
Diani Chandra Pertiwi Avatar asked Jun 14 '11 07:06

Diani Chandra Pertiwi


People also ask

How do I add a main page in doxygen?

To add content to the mainpage, use the doxygen special command \mainpage. To enhance the documentation you produce, there are a variety of doxygen special commands placed inside doxygen comments. For example, in the class description, note the doxygen special command \author.

How do I enter a code on doxygen?

You can put example source code in a special path defined in the doxygen config under EXAMPLE_PATH , and then insert examples with the @example tag. Doxygen will then generate an extra page containing the source of the example. It will also set a link to it from the class documentation containing the example tag.


1 Answers

To add to the comments on your question, the \page command will add pages into your documentation that you have manually written. I.e. if a source file contains a \page declaration it will add the contents to the documentation index. You can add extra help here, such as:

/*! \page overviewpage Architecture Overview
 *
 * \section memorymanagement Memory Management
 *
 * Some writing you want to appear as a help page in the documentation here.
 */

The \include command will include a copy of a file as a source code block.

I think you're actually asking how you get Doxygen to add multiple source directories. As long as the recursive setting is YES, which is not the default, it should work fine for your structure if you've set the root folder as the Doxygen input.

RECURSIVE              = YES

If you haven't, you can add different folders like this, with paths relative to the Doxyfile file.

#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------

# The INPUT tag can be 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.

INPUT                  = src test/src
like image 134
Martin Foot Avatar answered Oct 17 '22 23:10

Martin Foot