Project

General

Profile

Task #641

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

Add and document a template for using the new analysis framework

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

I already have a template implementation that worked on an earlier implementation of the framework, so it should not be too hard to update it to match the current one.


Related issues

Blocked by GROMACS - Task #640: Add/update Doxygen documentation for src/gromacs/trajectoryanalysis/Closed01/08/2011

Associated revisions

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

Added a C++ template for analysis tools.

Also added a C++ wrapper for the neighborhood search code used in the
selection module for use in analysis tools.

IssueID #641

Revision 7cf69ec8 (diff)
Added by Teemu Murtola about 9 years ago

Added documentation for the C++ analysis template.

The documentation now walks through the basic structure of the template,
but it does not explain all the details.

IssueID #641

Revision 8427f417 (diff)
Added by Teemu Murtola almost 8 years ago

Updates to template documentation.

- Small updates to the template analysis tool.
- Updated the Doxygen documentation for the template (still needs more
details).
- Removed obsolete and non-functional C template and its documentation.

Related to issue #641.

Change-Id: I25ecfce8137344391b7651b68b0f3bbce79f9556

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

Add documentation for template.cpp.

- Add more description of template.cpp to its Doxygen comments,
referencing other parts of the Doxygen documentation where
appropriate.
- Adjust the naming convention in template.cpp to use a trailing
underscore instead of a leading one (the convention elsewhere in the
code is currently a bit mixed, but in recent code I've used the
trailing underscore).

Resolves #641.

Change-Id: Ie653550f3a3ace13482ba9a08f35344dbe188ada

History

#1 Updated by Teemu Murtola about 9 years ago

  • Status changed from New to In Progress
  • Start date changed from 01/08/2011 to 01/10/2011
  • % Done changed from 0 to 50

There is now a template, but it is not yet documented; documentation will be easier to write after #640 is done.

#2 Updated by Teemu Murtola about 8 years ago

  • Parent task set to #867

#3 Updated by Teemu Murtola almost 8 years ago

  • Target version set to 5.0

#4 Updated by Teemu Murtola almost 8 years ago

  • Status changed from In Progress to Feedback wanted

Change Ie653550f should add sufficient documentation to close this issue.

#5 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, but the parent issue remains open for any additional changes.

#6 Updated by Teemu Murtola over 5 years ago

  • Category set to documentation

Also available in: Atom PDF