Project

General

Profile

Task #867

Updated by Teemu Murtola about 8 years ago

In particular the transition to use exceptions throughout the C++ code left some obsolete Doxygen comments in different places in the code. While going through the code, I identified some additional refactoring needs, but now quite a few of those have been addressed. It would be useful to go through Doxygen comments in particular in the following directories:

* src/gromacs/analysisdata/

* src/gromacs/selection/

* src/gromacs/trajectoryanalysis/

Things to pay particular attention to:

* Are Doxygen comments up-to-date with the current behavior?

* Document exception behavior where applicable.

* In src/gromacs/selection/, files converted from earlier C framework still contain comments that are in a different style than adopted for C++. Relevant parts, and in particular the separate pages (e.g., selection parsing and compilation) should be linked to the new documentation hierarchy. Converting documentation for intramodule functions isn't a high priority.

* Check that relevant output is produced for each level of documentation (i.e., with each Doxyfile generated at the build tree root).

* Anything else that seems to be poorly documented.

src/gromacs/options/ should be quite well up-to-date. fatalerror/ and utility/ contain a limited amount of code, which should be quite fast to check at the same time.

Will link other existing Doxygen documentation tasks as children or related tasks to this issue to have them better organized.

Back