From e0ce6f0a2219cf50513f9ac41ecef89b7c11cda9 Mon Sep 17 00:00:00 2001 From: Brad King Date: Tue, 22 Oct 2013 10:24:25 -0400 Subject: [PATCH] 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. --- Help/manual/cmake-developer.7.rst | 3 +++ Source/cmRST.h | 10 ++++++++++ 2 files changed, 13 insertions(+) diff --git a/Help/manual/cmake-developer.7.rst b/Help/manual/cmake-developer.7.rst index a9e3e463a..eace3a4f7 100644 --- a/Help/manual/cmake-developer.7.rst +++ b/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 defined by reStructuredText, Sphinx, and a CMake extension to Sphinx. +.. + Note: This list must be kept consistent with the cmRST implementation. + CMake Domain directives Directives defined in the `CMake Domain`_ for defining CMake documentation objects are printed in command-line help output as diff --git a/Source/cmRST.h b/Source/cmRST.h index faae25fd2..1a3cd994c 100644 --- a/Source/cmRST.h +++ b/Source/cmRST.h @@ -16,6 +16,16 @@ #include +/** \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: