Skip to content

Commit 2fbc9f2

Browse files
committed
[clang-format][doc] Clean up quotes, etc.
1 parent ab08df2 commit 2fbc9f2

File tree

2 files changed

+68
-70
lines changed

2 files changed

+68
-70
lines changed

clang/docs/ClangFormatStyleOptions.rst

Lines changed: 34 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1799,8 +1799,8 @@ the configuration (without a prefix: ``Auto``).
17991799
Never merge functions into a single line.
18001800

18011801
* ``SFS_InlineOnly`` (in configuration: ``InlineOnly``)
1802-
Only merge functions defined inside a class. Same as "inline",
1803-
except it does not implies "empty": i.e. top level empty functions
1802+
Only merge functions defined inside a class. Same as ``inline``,
1803+
except it does not implies ``empty``: i.e. top level empty functions
18041804
are not merged either.
18051805

18061806
.. code-block:: c++
@@ -1825,7 +1825,7 @@ the configuration (without a prefix: ``Auto``).
18251825
}
18261826

18271827
* ``SFS_Inline`` (in configuration: ``Inline``)
1828-
Only merge functions defined inside a class. Implies "empty".
1828+
Only merge functions defined inside a class. Implies ``empty``.
18291829

18301830
.. code-block:: c++
18311831

@@ -2042,7 +2042,7 @@ the configuration (without a prefix: ``Auto``).
20422042

20432043
.. code-block:: yaml
20442044
2045-
AttributeMacros: ['__capability', '__output', '__unused']
2045+
AttributeMacros: [__capability, __output, __unused]
20462046
20472047
.. _BinPackArguments:
20482048

@@ -3802,7 +3802,7 @@ the configuration (without a prefix: ``Auto``).
38023802

38033803
.. code-block:: yaml
38043804
3805-
ForEachMacros: ['RANGES_FOR', 'FOREACH']
3805+
ForEachMacros: [RANGES_FOR, FOREACH]
38063806
38073807
For example: BOOST_FOREACH.
38083808

@@ -3825,7 +3825,7 @@ the configuration (without a prefix: ``Auto``).
38253825

38263826
.. code-block:: yaml
38273827
3828-
IfMacros: ['IF']
3828+
IfMacros: [IF]
38293829
38303830
For example: `KJ_IF_MAYBE
38313831
<https://github.com/capnproto/capnproto/blob/master/kjdoc/tour.md#maybes>`_
@@ -4374,7 +4374,7 @@ the configuration (without a prefix: ``Auto``).
43744374

43754375
.. code-block:: yaml
43764376
4377-
JavaImportGroups: ['com.example', 'com', 'org']
4377+
JavaImportGroups: [com.example, com, org]
43784378
43794379
43804380
.. code-block:: java
@@ -4438,7 +4438,7 @@ the configuration (without a prefix: ``Auto``).
44384438
VeryLongImportsAreAnnoying,
44394439
VeryLongImportsAreAnnoying,
44404440
VeryLongImportsAreAnnoying,
4441-
} from 'some/module.js'
4441+
} from "some/module.js"
44424442
44434443
false:
44444444
import {VeryLongImportsAreAnnoying, VeryLongImportsAreAnnoying, VeryLongImportsAreAnnoying,} from "some/module.js"
@@ -5088,7 +5088,7 @@ the configuration (without a prefix: ``Auto``).
50885088

50895089
.. code-block:: yaml
50905090
5091-
QualifierOrder: ['inline', 'static', 'type', 'const']
5091+
QualifierOrder: [inline, static, type, const]
50925092
50935093
50945094
.. code-block:: c++
@@ -5117,16 +5117,16 @@ the configuration (without a prefix: ``Auto``).
51175117

51185118
.. note::
51195119

5120-
it MUST contain 'type'.
5120+
It must contain ``type``.
51215121

5122-
Items to the left of 'type' will be placed to the left of the type and
5123-
aligned in the order supplied. Items to the right of 'type' will be
5122+
Items to the left of ``type`` will be placed to the left of the type and
5123+
aligned in the order supplied. Items to the right of ``type`` will be
51245124
placed to the right of the type and aligned in the order supplied.
51255125

51265126

51275127
.. code-block:: yaml
51285128
5129-
QualifierOrder: ['inline', 'static', 'type', 'const', 'volatile' ]
5129+
QualifierOrder: [inline, static, type, const, volatile]
51305130
51315131
.. _RawStringFormats:
51325132

@@ -5138,10 +5138,10 @@ the configuration (without a prefix: ``Auto``).
51385138
name will be reformatted assuming the specified language based on the
51395139
style for that language defined in the .clang-format file. If no style has
51405140
been defined in the .clang-format file for the specific language, a
5141-
predefined style given by 'BasedOnStyle' is used. If 'BasedOnStyle' is not
5142-
found, the formatting is based on llvm style. A matching delimiter takes
5143-
precedence over a matching enclosing function name for determining the
5144-
language of the raw string contents.
5141+
predefined style given by ``BasedOnStyle`` is used. If ``BasedOnStyle`` is
5142+
not found, the formatting is based on ``LLVM`` style. A matching delimiter
5143+
takes precedence over a matching enclosing function name for determining
5144+
the language of the raw string contents.
51455145

51465146
If a canonical delimiter is specified, occurrences of other delimiters for
51475147
the same language will be updated to the canonical if possible.
@@ -5156,17 +5156,17 @@ the configuration (without a prefix: ``Auto``).
51565156
RawStringFormats:
51575157
- Language: TextProto
51585158
Delimiters:
5159-
- 'pb'
5160-
- 'proto'
5159+
- pb
5160+
- proto
51615161
EnclosingFunctions:
5162-
- 'PARSE_TEXT_PROTO'
5162+
- PARSE_TEXT_PROTO
51635163
BasedOnStyle: google
51645164
- Language: Cpp
51655165
Delimiters:
5166-
- 'cc'
5167-
- 'cpp'
5168-
BasedOnStyle: llvm
5169-
CanonicalDelimiter: 'cc'
5166+
- cc
5167+
- cpp
5168+
BasedOnStyle: LLVM
5169+
CanonicalDelimiter: cc
51705170
51715171
.. _ReferenceAlignment:
51725172

@@ -5533,7 +5533,7 @@ the configuration (without a prefix: ``Auto``).
55335533

55345534
This determines the maximum length of short namespaces by counting
55355535
unwrapped lines (i.e. containing neither opening nor closing
5536-
namespace brace) and makes "FixNamespaceComments" omit adding
5536+
namespace brace) and makes ``FixNamespaceComments`` omit adding
55375537
end comments for those.
55385538

55395539
.. code-block:: c++
@@ -5645,7 +5645,7 @@ the configuration (without a prefix: ``Auto``).
56455645

56465646
* ``SUD_Lexicographic`` (in configuration: ``Lexicographic``)
56475647
Using declarations are sorted in the order defined as follows:
5648-
Split the strings by "::" and discard any initial empty strings. Sort
5648+
Split the strings by ``::`` and discard any initial empty strings. Sort
56495649
the lists of names lexicographically, and within those groups, names are
56505650
in case-insensitive lexicographic order.
56515651

@@ -5659,7 +5659,7 @@ the configuration (without a prefix: ``Auto``).
56595659

56605660
* ``SUD_LexicographicNumeric`` (in configuration: ``LexicographicNumeric``)
56615661
Using declarations are sorted in the order defined as follows:
5662-
Split the strings by "::" and discard any initial empty strings. The
5662+
Split the strings by ``::`` and discard any initial empty strings. The
56635663
last element of each list is a non-namespace name; all others are
56645664
namespace names. Sort the lists of names lexicographically, where the
56655665
sort order of individual names is that all non-namespace names come
@@ -5699,7 +5699,7 @@ the configuration (without a prefix: ``Auto``).
56995699
.. _SpaceAfterTemplateKeyword:
57005700

57015701
**SpaceAfterTemplateKeyword** (``Boolean``) :versionbadge:`clang-format 4` :ref:`<SpaceAfterTemplateKeyword>`
5702-
If ``true``, a space will be inserted after the 'template' keyword.
5702+
If ``true``, a space will be inserted after the ``template`` keyword.
57035703

57045704
.. code-block:: c++
57055705

@@ -5860,7 +5860,7 @@ the configuration (without a prefix: ``Auto``).
58605860

58615861
* ``SBPO_NonEmptyParentheses`` (in configuration: ``NonEmptyParentheses``)
58625862
Put a space before opening parentheses only if the parentheses are not
5863-
empty i.e. '()'
5863+
empty.
58645864

58655865
.. code-block:: c++
58665866

@@ -6245,7 +6245,7 @@ the configuration (without a prefix: ``Auto``).
62456245
true: false:
62466246
x = ( int32 )y vs. x = (int32)y
62476247

6248-
* ``bool InEmptyParentheses`` Put a space in parentheses only if the parentheses are empty i.e. '()'
6248+
* ``bool InEmptyParentheses`` Insert a space in empty parentheses, i.e. ``()``.
62496249

62506250
.. code-block:: c++
62516251

@@ -6409,10 +6409,9 @@ the configuration (without a prefix: ``Auto``).
64096409
.. code-block:: yaml
64106410
64116411
TableGenBreakInsideDAGArg: BreakAll
6412-
TableGenBreakingDAGArgOperators: ['ins', 'outs']
6413-
6412+
TableGenBreakingDAGArgOperators: [ins, outs]
64146413
makes the line break only occurs inside DAGArgs beginning with the
6415-
specified identifiers 'ins' and 'outs'.
6414+
specified identifiers ``ins`` and ``outs``.
64166415

64176416

64186417
.. code-block:: c++
@@ -6450,7 +6449,7 @@ the configuration (without a prefix: ``Auto``).
64506449

64516450
.. code-block:: yaml
64526451
6453-
TypenameMacros: ['STACK_OF', 'LIST']
6452+
TypenameMacros: [STACK_OF, LIST]
64546453
64556454
For example: OpenSSL STACK_OF, BSD LIST_ENTRY.
64566455

@@ -6518,7 +6517,7 @@ the configuration (without a prefix: ``Auto``).
65186517

65196518
.. code-block:: yaml
65206519
6521-
WhitespaceSensitiveMacros: ['STRINGIZE', 'PP_STRINGIZE']
6520+
WhitespaceSensitiveMacros: [STRINGIZE, PP_STRINGIZE]
65226521
65236522
For example: BOOST_PP_STRINGIZE
65246523

0 commit comments

Comments
 (0)