summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDaniel Jasper <djasper@google.com>2015-10-07 13:02:45 +0000
committerDaniel Jasper <djasper@google.com>2015-10-07 13:02:45 +0000
commit8e1ecca2ecbc8f95106c95e0fb6f16ff0f4e57f8 (patch)
treef3a9e05f97cb3133db1a57408c103c91b9f177a0
parentf2addf8905aadfc8c1e214c2c63a3b1b14e29d8b (diff)
downloadbcm5719-llvm-8e1ecca2ecbc8f95106c95e0fb6f16ff0f4e57f8.tar.gz
bcm5719-llvm-8e1ecca2ecbc8f95106c95e0fb6f16ff0f4e57f8.zip
clang-format: Hopefully fix code blocks in docs.
Otherwise I will have to install sphinx ;).. llvm-svn: 249542
-rw-r--r--clang/docs/ClangFormatStyleOptions.rst6
-rwxr-xr-xclang/docs/tools/dump_format_style.py2
2 files changed, 7 insertions, 1 deletions
diff --git a/clang/docs/ClangFormatStyleOptions.rst b/clang/docs/ClangFormatStyleOptions.rst
index 7d31a5869ce..da5b3b5ebd4 100644
--- a/clang/docs/ClangFormatStyleOptions.rst
+++ b/clang/docs/ClangFormatStyleOptions.rst
@@ -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
diff --git a/clang/docs/tools/dump_format_style.py b/clang/docs/tools/dump_format_style.py
index 3c04171044e..54760529ea6 100755
--- a/clang/docs/tools/dump_format_style.py
+++ b/clang/docs/tools/dump_format_style.py
@@ -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'
OpenPOWER on IntegriCloud