forked from OSchip/llvm-project
clang-format: Hopefully fix code blocks in docs.
Otherwise I will have to install sphinx ;).. llvm-svn: 249542
This commit is contained in:
parent
f2addf8905
commit
8e1ecca2ec
|
@ -157,6 +157,7 @@ the configuration (without a prefix: ``Auto``).
|
|||
brackets. This will result in formattings like
|
||||
|
||||
.. code-block:: c++
|
||||
|
||||
someLongFunction(argument1,
|
||||
argument2);
|
||||
|
||||
|
@ -167,6 +168,7 @@ the configuration (without a prefix: ``Auto``).
|
|||
will result in formattings like
|
||||
|
||||
.. code-block:: c++
|
||||
|
||||
int aaaa = 12;
|
||||
int b = 23;
|
||||
int ccc = 23;
|
||||
|
@ -178,6 +180,7 @@ the configuration (without a prefix: ``Auto``).
|
|||
will result in formattings like
|
||||
|
||||
.. code-block:: c++
|
||||
|
||||
int aaaa = 12;
|
||||
float b = 23;
|
||||
std::string ccc = 23;
|
||||
|
@ -394,12 +397,14 @@ the configuration (without a prefix: ``Auto``).
|
|||
These are expected to be macros of the form:
|
||||
|
||||
.. code-block:: c++
|
||||
|
||||
FOREACH(<variable-declaration>, ...)
|
||||
<loop-body>
|
||||
|
||||
In the .clang-format configuration file, this can be configured like:
|
||||
|
||||
.. code-block:: c++
|
||||
|
||||
ForEachMacros: ['RANGES_FOR', 'FOREACH']
|
||||
|
||||
For example: BOOST_FOREACH.
|
||||
|
@ -422,6 +427,7 @@ the configuration (without a prefix: ``Auto``).
|
|||
To configure this in the .clang-format file, use:
|
||||
|
||||
.. code-block:: c++
|
||||
|
||||
IncludeCategories:
|
||||
- Regex: '^"(llvm|llvm-c|clang|clang-c)/'
|
||||
Priority: 2
|
||||
|
|
|
@ -87,7 +87,7 @@ class EnumValue:
|
|||
|
||||
def clean_comment_line(line):
|
||||
if line == '/// \\code':
|
||||
return '\n.. code-block:: c++\n'
|
||||
return '\n.. code-block:: c++\n\n'
|
||||
if line == '/// \\endcode':
|
||||
return ''
|
||||
return line[4:] + '\n'
|
||||
|
|
Loading…
Reference in New Issue