Differences between revisions 1 and 2
Revision 1 as of 2010-04-23 13:56:48
Size: 1613
Editor: RalfDiener
Comment:
Revision 2 as of 2010-04-23 14:02:01
Size: 1628
Editor: RalfDiener
Comment:
Deletions are marked like this. Additions are marked like this.
Line 29: Line 29:
After these changes are saved, you run doxygen as above, but without the "-g" option in this folder. When it is finished, you can browse it by opening the "/path/to/program-installation/doc/html/index.html" file in the broweser of your choice. After these changes are saved, you run doxygen as above, but without the "-g" option in this folder. When it is finished, you can browse the documentation by opening the "/path/to/program-installation/doc/html/index.html" file in the broweser of your choice.

Creating Doxygen Documentation for Code without Doxygen Comments

In some cases, you would like to have a doxygen documentation, even if no doxygen comments are in the code (for example for CondDBMySQL). This can be usefull, to browse in a convenient way through the member functions of the classes to get an overview. This case will be described in the following.

In the first step, you should create an empty directory somewhere, for example the directory "doc" in the folder of your installation (here written as "/path/to/program-installation"). In this folder you issue the command:

doxygen -g

which creates an standard doxygen steering file. Then you edit the created file "Doxyfile" and change the following parameters (replace "/path/to/program-installation" by the correct path):

  • Define the directory, to where the doxygen documentation will be written.
    •    OUTPUT_DIRECTORY = /path/to/program-installation/doc
  • Define the input directories, where doxygen will search for files containing code.
    •    INPUT  = /path/to/program-installation/include
                  /path/to/program-installation/src
  • And last you change the line:
    •    EXTRACT_ALL            = YES 
      from "NO" to "YES". This tells doxygen to also include files without doxygen compatible comments.

After these changes are saved, you run doxygen as above, but without the "-g" option in this folder. When it is finished, you can browse the documentation by opening the "/path/to/program-installation/doc/html/index.html" file in the broweser of your choice.

Doxygentips (last edited 2010-04-23 14:07:38 by RalfDiener)