From: Daniel Jasper Date: Thu, 15 May 2014 13:55:19 +0000 (+0000) Subject: clang-format: Fix Sphinx build error. X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=bf45a93b45415cb4f7365858f4ff2e9cbbd2fdb5;p=clang clang-format: Fix Sphinx build error. Patch by Adam Strzelecki, thank you! git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@208882 91177308-0d34-0410-b5e6-96231b3b80d8 --- diff --git a/docs/ClangFormatStyleOptions.rst b/docs/ClangFormatStyleOptions.rst index b2157dd832..0483bd715e 100644 --- a/docs/ClangFormatStyleOptions.rst +++ b/docs/ClangFormatStyleOptions.rst @@ -341,9 +341,10 @@ the configuration (without a prefix: ``Auto``). If ``true``, spaces may be inserted into '()'. **SpacesBeforeTrailingComments** (``unsigned``) - The number of spaces before trailing line comments (//-comments). + The number of spaces before trailing line comments + (``//`` - comments). - This does not affect trailing block comments (/**/-comments) as those + This does not affect trailing block comments (``/**/`` - comments) as those commonly have different usage patterns and a number of special cases. **SpacesInAngles** (``bool``) diff --git a/include/clang/Format/Format.h b/include/clang/Format/Format.h index 4356ff0b03..56b796cf5f 100644 --- a/include/clang/Format/Format.h +++ b/include/clang/Format/Format.h @@ -120,9 +120,10 @@ struct FormatStyle { /// \brief The indentation used for namespaces. NamespaceIndentationKind NamespaceIndentation; - /// \brief The number of spaces before trailing line comments (//-comments). + /// \brief The number of spaces before trailing line comments + /// (\c // - comments). /// - /// This does not affect trailing block comments (/**/-comments) as those + /// This does not affect trailing block comments (\c /**/ - comments) as those /// commonly have different usage patterns and a number of special cases. unsigned SpacesBeforeTrailingComments;