This page documents how Doxygen is set up in the GROMACS source tree, as well as guidelines for adding new Doxygen comments. Examples are included, as well as tips and tricks for avoiding Doxygen warnings. The guidelines focus on C++ code and other new code that follows the new module layout. Parts of the guidelines are still applicable to documenting older code (e.g., within gmxlib/ or mdlib/), in particular the guidelines about formatting the Doxygen comments and the use of \internal. See Documentation organization for the overall structure of the documentation.
To get started quickly, you only need to read the first two sections to understand the overall structure of the documentation, and take a look at the examples at the end. The remaining sections provide the details for understanding why the examples are the way they are, and for more complex situations. They are meant more as a reference to look up solutions for particular problems, rather than single-time reading. To understand or find individual Doxygen commands, you should first look at Doxygen documentation (http://www.stack.nl/~dimitri/doxygen/manual/index.html).
The GROMACS source tree is set up to produce three different levels of Doxygen documentation:
Each subsequent level of documentation includes all the documentation from the levels above it. The suffixes above refer to the suffixes of Doxygen input and output files, as well as the name of the output directory. When all the flavors have been built, the front pages of the documentation contain links to the other flavors, and explain the differences in more detail.
As a general guideline, the public API documentation should be kept free of anything that a user linking against an unmodified GROMACS does not see. In other words, the public API documentation should mainly document the contents of installed headers, and provide the necessary overview of using those. Also, verbosity requirements for the public API documentation are higher: ideally, readers of the documentation could immediately start using the API based on the documentation, without any need to look at the implementation.
Similarly, the library API documentation should not contain things that other modules in GROMACS can or should never call. In particular, anything declared locally in source files should be only available in the full documentation. Also, if something is documented, and is not identified to be in the library API, then it should not be necessary to call that function from outside its module.
If you simply want to see up-to-date documentation, you can go to http://jenkins.gromacs.org/job/Documentation_Nightly_master/javadoc/html-lib/index.xhtml to see the documentation for the current development version. Jenkins also runs Doxygen for all changes pushed to Gerrit for release-5-0 and master branches, and the resulting documentation can be viewed from the link posted by Jenkins. The Doxygen build is marked as unstable if it introduces any Doxygen warnings.
You may need to build the documentation locally if you want to check the results after adding/modifying a significant amount of comments. This is recommended in particular if you do not have much experience with Doxygen. It is a good idea to build with all the different settings to see that the result is what you want, and that you do not produce any warnings. For local work, it is generally a good idea to set GMX_COMPACT_DOXYGEN=ON CMake option, which removes some large generated graphs from the documentation and speeds up the process significantly.
All files related to Doxygen reside in the docs/doxygen/ subdirectory in the source and build trees. In a freshly checked out source tree, this directory contains various Doxyfile-*.cmakein files. When you run CMake, corresponding files Doxyfile-user, Doxyfile-lib, and Doxyfile-full are generated at the corresponding location in the build tree. There is also a Doxyfile-common.cmakein, which is used to produce Doxyfile-common. This file contains settings that are shared between all the input files. Doxyfile-compact provides the extra settings for GMX_COMPACT_DOXYGEN=ON.
You can run Doxygen directly with one of the generated files (all output will be produced under the current working directory), or build one of the doxygen-user, doxygen-lib, and doxygen-full targets. The targets run Doxygen in a quieter mode and only show the warnings if there were any, and put the output under docs/html/doxygen/ in the build tree, so that the Doxygen build cooperates with the broader webpage target. The doxygen-all target builds all three targets with less typing.
The generated documentation is put under html-user/, html-lib/, and/or html-full/. Open index.xhtml file from one of these subdirectories to start browsing (for GROMACS developers, the html-lib/ is a reasonable starting point). Log files with all Doxygen warnings are also produced as docs/doxygen/doxygen-*.log, so you can inspect them after the run.
You will need Doxygen 1.8.5 to build the current documentation. Other versions may work, but likely also produce warnings. Additionally, graphviz and mscgen are required for some graphs in the documentation, and latex for formulas. Working versions are likely available through most package managers. It is possible to build the documentation without these tools, but you will see some errors and the related figures will be missing from the documentation.
Doxygen provides quite a few different alternative styles for documenting the source code. There are subtleties in how Doxygen treats the different types of comments, and this also depends somewhat on the Doxygen configuration. It is possible to change the meaning of a comment by just changing the style of comment it is enclosed in. To avoid such issues, and to avoid needing to manage all the alternatives, a single style throughout the source tree is preferable. When it comes to treatment of styles, GROMACS uses the default Doxygen configuration with one exception: JAVADOC_AUTOBRIEF is set ON to allow more convenient one-line brief descriptions in C code.
Majority of existing comments in GROMACS uses Qt-style comments (/*! and //! instead of /** and ///, \brief instead of @brief etc.), so these should be used also for new documentation. There is a single exception for brief comments in C code; see below.
Similarly, existing comments use /*! for multiline comments in both C and C++ code, instead of using multiple //! lines for C++. The rationale is that since the code will be a mixture of both languages for a long time, it is more uniform to use similar style in both. Also, since files will likely transition from C to C++ gradually, rewriting the comments because of different style issues should not generally be necessary. Finally, multi-line //! comments can work differently depending on Doxygen configuration, so it is better to avoid that ambiguity.
When adding comments, ensure that a short brief description is always produced. This is used in various listings, and should briefly explain the purpose of the method without unnecessarily expanding those lists. The basic guideline is to start all comment blocks with \brief (possibly after some other Doxygen commands). If you want to avoid the \brief for one-liners, you can use //!, but the description must fit on a single line; otherwise, it is not interpreted as a brief comment. Note in particular that a simple /*! without a \brief does not produce a brief description. Also note that \brief marks the whole following paragraph as a brief description, so you should insert an empty line after the intended brief description.
In C code, // comments must be avoided because some compilers do not like them. If you want to avoid the \brief for one-liners in C code, use /** instead of //!. If you do this, the brief description should not contain unescaped periods except at the end. Because of this, you should prefer //! in C++ code.
Put the documentation comments in the header file that contains the declaration, if such a header exists. Implementation-specific comments that do not influence how a method is used can go into the source file, just before the method definition, with an \internal tag in the beginning of the comment block. Doxygen-style comments within functions are not generally usable.
At times, you may need to exclude some part of a header or a source file such that Doxygen does not see it at all. In general, you should try to avoid this, but it may be necessary to remove some functions that you do not want to appear in the public API documentation, and which would generate warnings if left undocumented, or to avoid Doxygen warnings from code it does not understand. Prefer \cond and \endcond to do this. If \cond does not work for you, you can also use #ifndef DOXYGEN. If you exclude a class method in a header, you also need to exclude it in the source code to avoid warnings.
The general guidelines on the style of Doxygen comments were given above. This section introduces GROMACS specific constructs currently used in Doxygen documentation, as well as how GROMACS uses Doxygen groups to organize the documentation.
Some consistency checks are done automatically using custom scripts. See Source tree checker scripts for details.
To control in which level of documentation a certain function appears, three different mechanisms are used:
Examples of locations where it is necessary to use these explicit commands are given below in the sections on individual code constructs.
As described in Source code organization, each subdirectory under src/gromacs/ represents a module, i.e., a somewhat coherent collection of routines. Doxygen cannot automatically generate a list of routines in a module; it only extracts various alphabetical indexes that contain more or less all documented functions and classes. To help reading the documentation, the routines for a module should be visible in one place.
GROMACS uses Doxygen groups to achieve this: for each documented module, there is a \defgroup definition for the module, and all the relevant classes and functions need to be manually added to this group using \ingroup and \addtogroup. The group page also provides a natural place for overview documentation about the module, and can be navigated to directly from the “Modules” tab in the generated documentation.
Some notes about using \addtogroup are in order:
In addition to the module groups, two fixed groups are provided: group_publicapi and group_libraryapi. Classes and files can be added to these groups using GROMACS specific custom \inpublicapi and \inlibraryapi commands. The generated group documentation pages are not very useful, but annotated classes and files show the API definition under the name, making this information more easily accessible. These commands in file-level comments are also used for some automatic intermodule dependency validation (see below).
Note that functions, enumerations, and other entities that do not have a separate page in the generated documentation can only belong to one group; in such a case, the module group is preferred over the API group.
This section describes the techical details and some tips and tricks for documenting specific code constructs such that useful documentation is produced. If you are wondering where to document a certain piece of information, see the documentation structure section in Documentation organization. The focus of the documentation should be on the overview content: Doxygen pages and the module documentation. An experienced developer can relatively easily read and understand individual functions, but the documentation should help in getting the big picture.
The pages that are accessible through navigation from the front page are written using Markdown and are located under docs/doxygen/. Each page should be placed in the page hierarchy by making it a subpage of another page, i.e., it should be referenced once using \subpage. mainpage.md is the root of the hierarchy.
There are two subdirectories, user/ and lib/, determining the highest documentation level where the page appears. If you add pages to lib/, ensure that there are no references to the page from public API documentation. \if libapi can be used to add references in content that is otherwise public. Generally, the pages should be on a high enough level and provide overview content that is useful enough such that it is not necessary to exclude them from the library API documentation.
For each module, decide on a header file that is the most important one for that module (if there is no self-evident header, it may be better to designate, e.g., module-doc.h for this purpose, but this is currently not done for any module). This header should contain the \defgroup definition for the module. The name of the group should be module_name, where name is the name of the subdirectory that hosts the module.
The module should be added to an appropriate group (see docs/doxygen/misc.cpp for definitions) using \ingroup to organize the “Modules” tab in the generated documentation.
One or more contact persons who know about the contents of the module should be listed using \author commands. This provides a point of contact if one has questions.
Classes and structs in header files appear always in Doxygen documentation, even if their enclosing file is not documented. So start the documentation blocks of classes that are not part of the public API with \internal or \libinternal. Classes declared locally in source files or in unnamed namespaces only appear in the full documentation.
If a whole class is not documented, this does not currently generate any warning. The class is simply exluded from the documentation. But if a member of a documented class is not documented, a warning is generated. Guidelines for documenting free functions apply to methods of a class as well.
For base classes, the API classification (\inpublicapi or \inlibraryapi) should be based on where the class is meant to be subclassed. The visibility (\internal or \libinternal), in contrast, should reflect the API classification of derived classes such that the base class documentation is always generated together with the derived classes.
For classes that are meant to be subclassed and have protected members, the protected members should only appear at the documentation level where the class is meant to be subclassed. For example, if a class is meant to be subclassed only within a module, the protected members should only appear in the full documentation. This can be accomplished using \cond (note that you will need to add the \cond command also to the source files to hide the same methods from Doxygen, otherwise you will get confusing warnings).
These items do not appear in the documentation unless their enclosing scope is documented. For class members, the scope is the class; otherwise, it is the namespace if one exists, or the file. An \addtogroup can also define a scope if the group has higher visibility than the scope outside it. So if a function is not within a namespace (mostly applicable to C code) and has the same visibility as its enclosing file, it is not necessary to add a \internal or \libinternal.
Static functions are currently extracted for all documentation flavors to allow headers to declare static inline functions (used in, for example, math code). Functions in anonymous namespaces are only extracted into the full documentation. Together with the above rules, this means that you should avoid putting a static function within a documented namespace, even within source files, or it may inadvertently appear in the public API documentation.
If you want to exclude an item from the documentation, you need to put in inside a \cond block such that Doxygen does not see it. Otherwise, a warning for an undocumented function is generated. You need to enclose both the declaration and the definition with \cond.
Each documented file should start with a documentation block (right after the copyright notice) that documents the file. See the examples section for exact formatting. Things to note:
Directory documentation does not typically contain useful information beyond a possible brief description, since they correspond very closely to modules, and the modules themselves are documented. A brief description is still useful to provide a high-level overview of the source tree on the generated “Files” page. A reference to the module is typically sufficient as a brief description for a directory. All directories are currently documented in docs/doxygen/directories.cpp.
Here is an example of documenting a C++ class and its containing header file. Comments in the code and the actual documentation explain the used Doxygen constructs.
/*! \libinternal \file
* \brief
* Declares gmx::MyClass.
*
* More details. The documentation is still extracted for the class even if
* this whole comment block is missing.
*
* \author Example Author <example@author.com>
* \inlibraryapi
* \ingroup module_mymodule
*/
namespace gmx
{
/*! \libinternal
* \brief
* Brief description for the class.
*
* More details. The \libinternal tag is required for classes, since they are
* extracted into the documentation even in the absence of documentation for
* the enclosing scope.
* The \libinternal tag is on a separate line because of a bug in Doxygen
* 1.8.5 (only affects \internal, but for clarity it is also worked around
* here).
*
* \inlibraryapi
* \ingroup module_mymodule
*/
class MyClass
{
public:
// Trivial constructors or destructors do not require documentation.
// But if a constructor takes parameters, it should be documented like
// methods below.
MyClass();
~MyClass();
/*! \brief
* Brief description for the method.
*
* \param[in] param1 Description of the first parameter.
* \param[in] param2 Description of the second parameter.
* \returns Description of the return value.
* \throws std::bad_alloc if out of memory.
*
* More details describing the method. It is not an error to put this
* above the parameter block, but most existing code has it here.
*/
int myMethod(int param1, const char *param2) const;
//! Brief description for the accessor.
int simpleAccessor() const { return var_; }
/*! \brief
* Alternative, more verbose way of specifying a brief description.
*/
int anotherAccessor() const;
/*! \brief
* Brief description for another accessor that is so long that it does
* not conveniently fit on a single line cannot be specified with //!.
*/
int secondAccessor() const;
private:
// Private members (whether methods or variables) are currently ignored
// by Doxygen, so they don't need to be documented. Documentation
// doesn't hurt, though.
int var_;
};
} // namespace gmx
Here is another example of documenting a C header file (so avoiding all C++-style comments), and including free functions. It also demonstrates the use of \addtogroup to add multiple functions into a module group without repeated \ingroup tags.
/*! \file
* \brief
* Declares a collection of functions for performing a certain task.
*
* More details can go here.
*
* \author Example Author <example@author.com>
* \inpublicapi
* \ingroup module_mymodule
*/
/*! \addtogroup module_mymodule */
/*! \{ */
/*! \brief
* Brief description for the data structure.
*
* More details.
*
* \inpublicapi
*/
typedef struct {
/** Brief description for member. */
int member;
int second; /**< Brief description for the second member. */
/*! \brief
* Brief description for the third member.
*
* Details.
*/
int third;
} gmx_mystruct_t;
/*! \brief
* Performs a simple operation.
*
* \param[in] value Input value.
* \returns Computed value.
*
* Detailed description.
* \inpublicapi cannot be used here, because Doxygen only allows a single
* group for functions, and module_mymodule is the preferred group.
*/
int gmx_function(int value);
/* Any . in the brief description should be escaped as \. */
/** Brief description for this function. */
int gmx_simple_function();
/*! \} */
The rules where Doxygen expects something to be documented, and when are commands like \internal needed, can be complex. The examples below describe some of the pitfalls.
/*! \libinternal \file
* \brief
* ...
*
* The examples below assume that the file is documented like this:
* with an \libinternal definition at the beginning, with an intent to not
* expose anything from the file in the public API. Things work similarly for
* the full documentation if you replace \libinternal with \internal
* everywhere in the example.
*
* \ingroup module_example
*/
/*! \brief
* Brief description for a free function.
*
* A free function is not extracted into the documentation unless the enclosing
* scope (in this case, the file) is. So a \libinternal is not necessary.
*/
void gmx_function();
// Assume that the module_example group is defined in the public API.
//! \addtogroup module_example
//! \{
//! \cond libapi
/*! \brief
* Brief description for a free function within \addtogroup.
*
* In this case, the enclosing scope is actually the module_example group,
* which is documented, so the function needs to be explicitly excluded.
* \\libinternal does not work, since it would produce warnings about an
* undocumented function, so the whole declaration is hidden from Doxygen.
*/
void gmx_function();
//! \endcond
//! \}
// For modules that are only declared in the library API, \addtogroup
// cannot be used without an enclosing \cond. Otherwise, it will create
// a dummy module with the identifier as the name...
//! \cond libapi
//! \addtogroup module_libmodule
//! \{
/*! \brief
* Brief description.
*
* No \libinternal is necessary here because of the enclosing \cond.
*/
void gmx_function();
//! \}
//! \endcond
// An alternative to the above is use this, if the enclosing scope is only
// documented in the library API:
//! \libinternal \addtogroup module_libmodule
//! \{
//! Brief description.
void gmx_function()
//! \}
/*! \libinternal \brief
* Brief description for a struct.
*
* Documented structs and classes from headers are always extracted into the
* documentation, so \libinternal is necessary to exclude it.
* Currently, undocumented structs/classes do not produce warnings, so \cond
* is not necessary.
*/
struct t_example
{
int member1; //!< Each non-private member should be documented.
bool member2; //!< Otherwise, Doxygen will produce warnings.
};
// This namespace is documented in the public API.
namespace gmx
{
//! \cond libapi
/*! \brief
* Brief description for a free function within a documented namespace.
*
* In this case, the enclosing scope is the documented namespace,
* so a \cond is necessary to avoid warnings.
*/
void gmx_function();
//! \endcond
/*! \brief
* Class meant for subclassing only within the module, but the subclasses will
* be public.
*
* This base class still provides public methods that are visible through the
* subclasses, so it should appear in the public documentation.
* But it is not marked with \inpublicapi.
*/
class BaseClass
{
public:
/*! \brief
* A public method.
*
* This method also appears in the documentation of each subclass in
* the public and library API docs.
*/
void method();
protected:
// The \cond is necessary to exlude this documentation from the public
// API, since the public API does not support subclassing.
//! \cond internal
//! A method that only subclasses inside the module see.
void methodForSubclassToCall();
//! A method that needs to be implemented by subclasses.
virtual void virtualMethodToImplement() = 0;
//! \endcond
};
} // namespace gmx
Documenting a new module should place a comment like this in a central header for the module, such that the “Modules” tab in the generated documentation can be used to navigate to the module.
/*! \defgroup module_example "Example module (example)"
* \ingroup group_utilitymodules
* \brief
* Brief description for the module.
*
* Detailed description of the module. Can link to a separate Doxygen page for
* overview, and/or describe the most important headers and/or classes in the
* module as part of this documentation.
*
* For modules not exposed publicly, \libinternal can be added at the
* beginning (before \defgroup).
*
* \author Author Name <author.name@email.com>
*/
// In other code, use \addtogroup module_example and \ingroup module_example to
// add content (classes, functions, etc.) onto the module page.
The most common mistake, in particular in C code, is to forget to document the file. This causes Doxygen to ignore most comments in the file, so it does not validate the contents of the comments either, nor is it possible to actually check how the generated documentation looks like.
The following examples show some other common mistakes (and some less common) that do not produce correct documentation, as well as Doxygen “features”/bugs that can be confusing.
The struct itself is not documented; other comments within the declaration are ignored.
struct t_struct {
// The comment tries to document both members at once, but it only
// applies to the first. The second produces warnings about missing
// documentation (if the enclosing struct was documented).
//! Angle parameters.
double alpha, beta;
};
This does not produce any brief documentation. An explicit \brief is required, or //! (C++) or /** */ (C) should be used.
/*! Brief comment. */
int gmx_function();
This does not produce any documentation at all, since a ! is missing at the beginning.
/* \brief
* Brief description.
*
* More details.
*/
int gmx_function();
This puts the whole paragraph into the brief description. A short description is preferable, separated by an empty line from the rest of the text.
/*! \brief
* Brief description. The description continues with all kinds of details about
* what the function does and how it should be called.
*/
int gmx_function();
This may be a Doxygen bug, but this does not produce any brief description.
/** \internal Brief description. */
int gmx_function();
If the first declaration below appears in a header, and the second in a source file, then Doxygen does not associate them correctly and complains about missing documentation for the latter. The solution is to explicitly add a namespace prefix also in the source file, even though the compiler does not require it.
// Header file
//! Example function with a namespace-qualified parameter type.
int gmx_function(const gmx::SomeClass ¶m);
// Source file
using gmx::SomeClass;
int gmx_function(const SomeClass ¶m);
This puts the namespace into the mentioned module, instead of the contents of the namespace. \addtogroup should go within the innermost scope.
//! \addtogroup module_example
//! \{
namespace gmx
{
//! Function intended to be part of module_example.
int gmx_function();
}
More examples you can find by looking at existing code in the source tree. In particular new C++ code such as that in the src/gromacs/analysisdata/ and src/gromacs/options/ subdirectories contains a large amount of code documented mostly along these guidelines. Some comments in src/gromacs/selection/ (in particular, any C-like code) predate the introduction of these guidelines, so those are not the best examples.