diff options
| author | Brad King <brad.king@kitware.com> | 2013-10-23 12:20:01 (GMT) |
|---|---|---|
| committer | CMake Topic Stage <kwrobot@kitware.com> | 2013-10-23 12:20:01 (GMT) |
| commit | a8cfc218435b5adb92f9456f69b57f02ec1dcc43 (patch) | |
| tree | 254eaefceda06c652e7739f5fe0fcd88bbb6664f /Source | |
| parent | 8855bf53959331a290fe8947eb23afd719a52cf4 (diff) | |
| parent | e0ce6f0a2219cf50513f9ac41ecef89b7c11cda9 (diff) | |
| download | CMake-a8cfc218435b5adb92f9456f69b57f02ec1dcc43.zip CMake-a8cfc218435b5adb92f9456f69b57f02ec1dcc43.tar.gz CMake-a8cfc218435b5adb92f9456f69b57f02ec1dcc43.tar.bz2 | |
Merge topic 'doc-cmake-developer'
e0ce6f0 cmRST: Cross-reference cmake-developer.7 manual and cmRST Doxygen
c1c239b Help: Add documentation format to cmake-developer.7 manual
a06a90f Help: Organize cmake-developer.7 manual Modules section
28f08ba Help: Fix module documentation markup in cmake-developer.7 manual
baaab06 Help: Move Modules/readme.txt content into cmake-developer.7 manual
80a311e Help: Add cmake-developer.7 manual
Diffstat (limited to 'Source')
| -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: |