mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-05-12 17:19:05 -05:00
Code Issues Packages Projects Releases Wiki Activity

Merge topic 'doc-string-xref'

Browse Source 
510d81c7bc Help: Avoid reST named references in string(JSON) synopsis
6c0f37546f Help: Improve string(JSON) synopsis document source readability

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !11426
This commit is contained in:
Brad King
2025-11-18 14:04:41 +00:00
committed by Kitware Robot
parent ba1996eb15 510d81c7bc
commit bb877abc93
1 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Help/command/string.rst
+12 -12
View File
@@ -22,7 +22,7 @@ Synopsis
string(`JOIN`_ <glue> <out-var> [<input>...])
string(`TOLOWER`_ <string> <out-var>)
string(`TOUPPER`_ <string> <out-var>)
string(`LENGTH <LENGTH_>`_ <string> <out-var>)
string(`LENGTH`_ <string> <out-var>)
string(`SUBSTRING`_ <string> <begin> <length> <out-var>)
string(`STRIP`_ <string> <out-var>)
string(`GENEX_STRIP`_ <string> <out-var>)
@@ -46,16 +46,16 @@ Synopsis
`JSON`_
string(JSON <out-var> [ERROR_VARIABLE <error-var>]
{`GET <JSON GET_>`_ | `TYPE <JSON TYPE_>`_ | `LENGTH <JSON LENGTH_>`_ | `REMOVE <JSON REMOVE_>`_}
{`GET <JSON-GET_>`__ | `TYPE <JSON-TYPE_>`__ | `LENGTH <JSON-LENGTH_>`__ | `REMOVE <JSON-REMOVE_>`__}
<json-string> <member|index> [<member|index> ...])
string(JSON <out-var> [ERROR_VARIABLE <error-var>]
`MEMBER <JSON MEMBER_>`_ <json-string>
`MEMBER <JSON-MEMBER_>`__ <json-string>
[<member|index> ...] <index>)
string(JSON <out-var> [ERROR_VARIABLE <error-var>]
`SET <JSON SET_>`_ <json-string>
`SET <JSON-SET_>`__ <json-string>
<member|index> [<member|index> ...] <value>)
string(JSON <out-var> [ERROR_VARIABLE <error-var>]
`EQUAL <JSON EQUAL_>`_ <json-string1> <json-string2>)
`EQUAL <JSON-EQUAL_>`__ <json-string1> <json-string2>)
Search and Replace
^^^^^^^^^^^^^^^^^^
@@ -550,7 +550,7 @@ string is passed as a single argument even if it contains semicolons.
.. signature::
string(JSON <out-var> [ERROR_VARIABLE <error-variable>]
GET <json-string> <member|index> [<member|index> ...])
:target: JSON GET
:target: JSON-GET
Get an element from ``<json-string>`` at the location given
by the list of ``<member|index>`` arguments.
@@ -562,7 +562,7 @@ string is passed as a single argument even if it contains semicolons.
.. signature::
string(JSON <out-var> [ERROR_VARIABLE <error-variable>]
TYPE <json-string> <member|index> [<member|index> ...])
:target: JSON TYPE
:target: JSON-TYPE
Get the type of an element in ``<json-string>`` at the location
given by the list of ``<member|index>`` arguments. The ``<out-var>``
@@ -573,7 +573,7 @@ string is passed as a single argument even if it contains semicolons.
string(JSON <out-var> [ERROR_VARIABLE <error-var>]
MEMBER <json-string>
[<member|index> ...] <index>)
:target: JSON MEMBER
:target: JSON-MEMBER
Get the name of the ``<index>``-th member in ``<json-string>``
at the location given by the list of ``<member|index>`` arguments.
@@ -582,7 +582,7 @@ string is passed as a single argument even if it contains semicolons.
.. signature::
string(JSON <out-var> [ERROR_VARIABLE <error-variable>]
LENGTH <json-string> [<member|index> ...])
:target: JSON LENGTH
:target: JSON-LENGTH
Get the length of an element in ``<json-string>`` at the location
given by the list of ``<member|index>`` arguments.
@@ -591,7 +591,7 @@ string is passed as a single argument even if it contains semicolons.
.. signature::
string(JSON <out-var> [ERROR_VARIABLE <error-variable>]
REMOVE <json-string> <member|index> [<member|index> ...])
:target: JSON REMOVE
:target: JSON-REMOVE
Remove an element from ``<json-string>`` at the location
given by the list of ``<member|index>`` arguments. The JSON string
@@ -600,7 +600,7 @@ string is passed as a single argument even if it contains semicolons.
.. signature::
string(JSON <out-var> [ERROR_VARIABLE <error-variable>]
SET <json-string> <member|index> [<member|index> ...] <value>)
:target: JSON SET
:target: JSON-SET
Set an element in ``<json-string>`` at the location
given by the list of ``<member|index>`` arguments to ``<value>``.
@@ -612,7 +612,7 @@ string is passed as a single argument even if it contains semicolons.
.. signature::
string(JSON <out-var> [ERROR_VARIABLE <error-var>]
EQUAL <json-string1> <json-string2>)
:target: JSON EQUAL
:target: JSON-EQUAL
Compare the two JSON objects given by ``<json-string1>``
and ``<json-string2>`` for equality. The contents of ``<json-string1>``