maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity

[clang-format][docfix] Update predefined styles in docs 

Summary:
The predefined styles that clang-format supports are listed in two
places, and neither is up-to-date. GNU style isn't mentioned at all!

Subscribers: cfe-commits

Tags: #clang

Differential Revision: https://reviews.llvm.org/D80309
This commit is contained in:
Jake Merdich 2020-05-20 12:17:55 -04:00
parent 48a8c7dcbf
commit 51dbda5438
2 changed files with 24 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
clang/docs/ClangFormatStyleOptions.rst
View File

@ -151,6 +151,9 @@ the configuration (without a prefix: ``Auto``).
* ``Microsoft``
A style complying with `Microsoft's style guide
<https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference?view=vs-2017>`_
* ``GNU``
A style complying with the `GNU coding standards
<https://www.gnu.org/prep/standards/standards.html>`_
.. START_FORMAT_STYLE_OPTIONS

22
clang/docs/LibFormat.rst
View File

@ -40,7 +40,7 @@ Style Options
The style options describe specific formatting options that can be used in
order to make `ClangFormat` comply with different style guides. Currently,
two style guides are hard-coded:
several style guides are hard-coded:
.. code-block:: c++
@ -52,6 +52,26 @@ two style guides are hard-coded:
/// http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml.
FormatStyle getGoogleStyle();
/// Returns a format style complying with Chromium's style guide:
/// https://chromium.googlesource.com/chromium/src/+/master/styleguide/styleguide.md
FormatStyle getChromiumStyle();
/// Returns a format style complying with the GNU coding standards:
/// https://www.gnu.org/prep/standards/standards.html
FormatStyle getGNUStyle();
/// Returns a format style complying with Mozilla's style guide
/// https://firefox-source-docs.mozilla.org/code-quality/coding-style/index.html
FormatStyle getMozillaStyle();
/// Returns a format style complying with Webkit's style guide:
/// https://webkit.org/code-style-guidelines/
FormatStyle getWebkitStyle();
/// Returns a format style complying with Microsoft's style guide:
/// https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference
FormatStyle getMicrosoftStyle();
These options are also exposed in the :doc:`standalone tools <ClangFormat>`
through the `-style` option.