summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2024-05-31 19:14:50 (GMT)
committerBrad King <brad.king@kitware.com>2024-06-05 16:58:47 (GMT)
commitd9ab1fb5da2a49de7e1a69cbd0775a219019e6be (patch)
treee9c430a6b8d40aef1f3dfa9228539eec76ca33ac
parentaa3fffa4bb5772fa83cf82189ecdd6a8c88e61b4 (diff)
downloadCMake-d9ab1fb5da2a49de7e1a69cbd0775a219019e6be.zip
CMake-d9ab1fb5da2a49de7e1a69cbd0775a219019e6be.tar.gz
CMake-d9ab1fb5da2a49de7e1a69cbd0775a219019e6be.tar.bz2
Help/dev: Fix formatting in CMake Documentation Guide
-rw-r--r--Help/dev/documentation.rst18
1 files changed, 9 insertions, 9 deletions
diff --git a/Help/dev/documentation.rst b/Help/dev/documentation.rst
index 00413e1..8270bb1 100644
--- a/Help/dev/documentation.rst
+++ b/Help/dev/documentation.rst
@@ -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
to *force* a line break. The default value is 'smart'. Allowable values are:
- ``all``
- Allow line breaks at any whitespace.
+``all``
+ Allow line breaks at any whitespace.
- ``smart`` (default)
- Allow line breaks at whitespace, except between matched square- or
- angle-brackets. For example, if a signature contains the text
- ``<input>... [OUTPUT_VARIABLE <out-var>]``, a line break would be allowed
- after ``<input>...`` but not between ``OUTPUT_VARIABLE`` and ``<out-var>``.
+``smart`` (default)
+ Allow line breaks at whitespace, except between matched square- or
+ angle-brackets. For example, if a signature contains the text
+ ``<input>... [OUTPUT_VARIABLE <out-var>]``, a line break would be allowed
+ after ``<input>...`` but not between ``OUTPUT_VARIABLE`` and ``<out-var>``.
- ``verbatim``
- Allow line breaks only where the source document contains a newline.
+``verbatim``
+ Allow line breaks only where the source document contains a newline.
The directive treats its content as the documentation of the signature(s).
Indent the signature documentation accordingly.