diff options
| author | Brad King <brad.king@kitware.com> | 2013-10-22 14:24:25 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2013-10-22 14:55:23 (GMT) |
| commit | e0ce6f0a2219cf50513f9ac41ecef89b7c11cda9 (patch) | |
| tree | 5957e80b3381a901f122da3f46137664f97b79fd /Source/cmRST.h | |
| parent | c1c239bf75736fc6b27630ffc7ece52e71f0b13c (diff) | |
| download | CMake-e0ce6f0a2219cf50513f9ac41ecef89b7c11cda9.zip CMake-e0ce6f0a2219cf50513f9ac41ecef89b7c11cda9.tar.gz CMake-e0ce6f0a2219cf50513f9ac41ecef89b7c11cda9.tar.bz2 | |
cmRST: Cross-reference cmake-developer.7 manual and cmRST Doxygen
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.
Diffstat (limited to 'Source/cmRST.h')
| -rw-r--r-- | Source/cmRST.h | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/Source/cmRST.h b/Source/cmRST.h index faae25f..1a3cd99 100644 --- a/Source/cmRST.h +++ b/Source/cmRST.h @@ -16,6 +16,16 @@ #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 { public: |