Refactor rst parsing for console output

[alexxy/gromacs.git] / src / gromacs / onlinehelp-doc.h

diff --git a/src/gromacs/onlinehelp-doc.h b/src/gromacs/onlinehelp-doc.h
index 8a7e1f722378f8fd9bf396e96d0e603ecdfd0e1e..fd1e7a0c9f99675676af62f691b013833cf80d30 100644 (file)
--- a/src/gromacs/onlinehelp-doc.h
+++ b/src/gromacs/onlinehelp-doc.h
@@ -44,6 +44,8 @@
  *    output formats from the same input strings and API calls.  Whenever
  *    possible, the output format should be abstracted using this interface,
  *    but in some cases code still writes out raw reStructuredText.
+ *  - rstparser.h provides the functionality to parse reStructuredText such that
+ *    it can be rewrapped for console output.
  *  - helpformat.h provides some general text-processing classes, currently
  *    focused on producing aligned tables for console output.
  *  - helptopicinterface.h, helptopic.h, and helpmanager.h provide classes for