kolan/CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

cmRST: Cross-reference cmake-developer.7 manual and cmRST Doxygen

Browse Source 
The cmRST implementation and the list of capabilities documented in the
cmake-developer.7 manual must be kept in sync.  Add a note to each file
to reference the other.
This commit is contained in:
Brad King 2013-10-22 10:24:25 -04:00
parent c1c239bf75
commit e0ce6f0a22
2 changed files with 13 additions and 0 deletions

3
Help/manual/cmake-developer.7.rst

@ -34,6 +34,9 @@ Sphinx-generated html and man pages.
The command-line help processor supports the following constructs The command-line help processor supports the following constructs
defined by reStructuredText, Sphinx, and a CMake extension to Sphinx. defined by reStructuredText, Sphinx, and a CMake extension to Sphinx.
..
Note: This list must be kept consistent with the cmRST implementation.
CMake Domain directives CMake Domain directives
Directives defined in the `CMake Domain`_ for defining CMake Directives defined in the `CMake Domain`_ for defining CMake
documentation objects are printed in command-line help output as documentation objects are printed in command-line help output as

10
Source/cmRST.h

@ -16,6 +16,16 @@
#include <cmsys/RegularExpression.hxx> #include <cmsys/RegularExpression.hxx>
/** \class cmRST
* \brief Perform basic .rst processing for command-line help
*
* This class implements a subset of reStructuredText and Sphinx
* document processing. It is used to print command-line help.
*
* If you modify the capabilities of this class, be sure to update
* the Help/manual/cmake-developer.7.rst documentation and to update
* the Tests/CMakeLib/testRST.(rst|expect) test input and output.
*/
class cmRST class cmRST
{ {
public: public: