mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-04-21 21:58:50 -05:00
Code Issues Packages Projects Releases Wiki Activity

Help/dev: Fix formatting in CMake Documentation Guide

Browse Source
This commit is contained in:
Brad King
2024-05-31 15:14:50 -04:00
parent aa3fffa4bb
commit d9ab1fb5da
1 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Help/dev/documentation.rst
+9 -9
View File
@@ -310,17 +310,17 @@ are suppressed inside of square- or angle-brackets. This behavior can be
controlled using the ``:break:`` option; note, however, that there is no way controlled using the ``:break:`` option; note, however, that there is no way
to *force* a line break. The default value is 'smart'. Allowable values are: to *force* a line break. The default value is 'smart'. Allowable values are:
``all`` ``all``
Allow line breaks at any whitespace. Allow line breaks at any whitespace.
``smart`` (default) ``smart`` (default)
Allow line breaks at whitespace, except between matched square- or Allow line breaks at whitespace, except between matched square- or
angle-brackets. For example, if a signature contains the text angle-brackets. For example, if a signature contains the text
``<input>... [OUTPUT_VARIABLE <out-var>]``, a line break would be allowed ``<input>... [OUTPUT_VARIABLE <out-var>]``, a line break would be allowed
after ``<input>...`` but not between ``OUTPUT_VARIABLE`` and ``<out-var>``. after ``<input>...`` but not between ``OUTPUT_VARIABLE`` and ``<out-var>``.
``verbatim`` ``verbatim``
Allow line breaks only where the source document contains a newline. Allow line breaks only where the source document contains a newline.
The directive treats its content as the documentation of the signature(s). The directive treats its content as the documentation of the signature(s).
Indent the signature documentation accordingly. Indent the signature documentation accordingly.