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

Help: Reference cmake-language.7 comment docs from cmake-developer.7 

The cmake-language.7 manual now documents comment syntax.  Reference it
from cmake-developer.7 when discussing how to add comment-enclosed
documentation to modules.
This commit is contained in:
Brad King 2013-11-08 08:21:08 -05:00
parent a931ee4414
commit 79fd233806
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Help/manual/cmake-developer.7.rst
View File

@ -255,7 +255,8 @@ containing just the line::
The ``cmake-module`` directive will scan the module file to extract The ``cmake-module`` directive will scan the module file to extract
reStructuredText markup from comment blocks that start in ``.rst:``. reStructuredText markup from comment blocks that start in ``.rst:``.
Add to the top of ``Modules/<module-name>.cmake`` a #-comment of the form: Add to the top of ``Modules/<module-name>.cmake`` a
:ref:`Line Comment` block of the form:
.. code-block:: cmake .. code-block:: cmake
@ -265,7 +266,7 @@ Add to the top of ``Modules/<module-name>.cmake`` a #-comment of the form:
# #
# <reStructuredText documentation of module> # <reStructuredText documentation of module>
or a bracket-comment of the form: or a :ref:`Bracket Comment` of the form:
.. code-block:: cmake .. code-block:: cmake