diff options
| author | Brad King <brad.king@kitware.com> | 2013-11-08 13:21:08 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2013-11-08 13:41:49 (GMT) |
| commit | 79fd233806960fdf84d912a34f1c3a801e13b5be (patch) | |
| tree | 486233e8d52bb924b643775dc39c4a48feaeeb23 /Help | |
| parent | a931ee44143b7ef3d0106ed5da497e66229aa073 (diff) | |
| download | CMake-79fd233806960fdf84d912a34f1c3a801e13b5be.zip CMake-79fd233806960fdf84d912a34f1c3a801e13b5be.tar.gz CMake-79fd233806960fdf84d912a34f1c3a801e13b5be.tar.bz2 | |
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.
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/manual/cmake-developer.7.rst | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/Help/manual/cmake-developer.7.rst b/Help/manual/cmake-developer.7.rst index 5d20c54..5857acf 100644 --- a/Help/manual/cmake-developer.7.rst +++ b/Help/manual/cmake-developer.7.rst @@ -255,7 +255,8 @@ containing just the line:: The ``cmake-module`` directive will scan the module file to extract 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 @@ -265,7 +266,7 @@ Add to the top of ``Modules/<module-name>.cmake`` a #-comment of the form: # # <reStructuredText documentation of module> -or a bracket-comment of the form: +or a :ref:`Bracket Comment` of the form: .. code-block:: cmake |