Project

General

Profile

Task #640

Task #867: Update Doxygen documentation for C++ code

Add/update Doxygen documentation for src/gromacs/trajectoryanalysis/

Added by Teemu Murtola about 9 years ago. Updated over 5 years ago.

Status:
Closed
Priority:
Normal
Assignee:
Category:
documentation
Target version:
Difficulty:
uncategorized
Close

Description

There is a significant amount of comments in these files, but many of them are outdated because of recent changes.


Related issues

Blocks GROMACS - Task #641: Add and document a template for using the new analysis frameworkClosed01/10/2011

Associated revisions

Revision 78df7c0f (diff)
Added by Teemu Murtola about 9 years ago

Improved Doxygen docs for trajectoryanalysis/.

The public API is now documented at some level, but a lot still remains
to be improved.

IssueID #640

Revision 881a24c2 (diff)
Added by Teemu Murtola almost 8 years ago

More comments for trajectoryanalysis.

- Added/updated/made more uniform Doxygen comments for general classes
in the trajectoryanalysis subdirectory.
- Removed an unnecessary method to avoid copying documentation for it.
- Removed some commented-out code.

Part of issue #640 (child of #867).

Change-Id: I2fb4a03a2054ba0e63581b3815ad6f7176ce57a2

History

#1 Updated by Teemu Murtola about 8 years ago

  • Parent task set to #867

#2 Updated by Teemu Murtola almost 8 years ago

  • Status changed from New to In Progress

#3 Updated by Teemu Murtola almost 8 years ago

  • Status changed from In Progress to Feedback wanted
  • Target version set to 5.0

There is a change pending review in gerrit that should bring the documentation up-to-date at least for the general-level classes.

#4 Updated by Teemu Murtola almost 8 years ago

  • Status changed from Feedback wanted to Closed

The mentioned change has been merged. Closing this issue as the documentation is now on a relatively good level at least for public classes, but the parent issue remains open for any additional changes.

#5 Updated by Teemu Murtola over 5 years ago

  • Category set to documentation

Also available in: Atom PDF