[PATCH] clang-format docs: Rst asterisk has to be escaped

[Daniel Jasper]

Thank you. Do you have commit access?


On Thu, May 15, 2014 at 2:37 PM, Adam Strzelecki <ono at java.pl> wrote:

> This fixes Sphinx build error:
>   Warning, treated as error:
>   WARNING: Inline emphasis start-string without end-string.
> ---
>  docs/ClangFormatStyleOptions.rst | 5 +++--
>  include/clang/Format/Format.h    | 5 +++--
>  2 files changed, 6 insertions(+), 4 deletions(-)
>
> diff --git a/docs/ClangFormatStyleOptions.rst
> b/docs/ClangFormatStyleOptions.rst
> index b2157dd..0483bd7 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 4356ff0..56b796c 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;
>
> --
> 1.8.5.2 (Apple Git-48)
>
> _______________________________________________
> cfe-commits mailing list
> cfe-commits at cs.uiuc.edu
> http://lists.cs.uiuc.edu/mailman/listinfo/cfe-commits
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/cfe-commits/attachments/20140515/17516f1c/attachment.html>