diff options
| author | 2020-08-03 15:06:44 +0000 | |
|---|---|---|
| committer | 2020-08-03 15:06:44 +0000 | |
| commit | b64793999546ed8adebaeebd9d8345d18db8927d (patch) | |
| tree | 4357c27b561d73b0e089727c6ed659f2ceff5f47 /gnu/llvm/tools/clang/docs/LibFormat.rst | |
| parent | Add support for UTF-8 DISPLAY-HINTs with octet length. For now only (diff) | |
| download | wireguard-openbsd-b64793999546ed8adebaeebd9d8345d18db8927d.tar.xz wireguard-openbsd-b64793999546ed8adebaeebd9d8345d18db8927d.zip | |
Remove LLVM 8.0.1 files.
Diffstat (limited to 'gnu/llvm/tools/clang/docs/LibFormat.rst')
| -rw-r--r-- | gnu/llvm/tools/clang/docs/LibFormat.rst | 58 |
1 files changed, 0 insertions, 58 deletions
diff --git a/gnu/llvm/tools/clang/docs/LibFormat.rst b/gnu/llvm/tools/clang/docs/LibFormat.rst deleted file mode 100644 index 889fbbac8c7..00000000000 --- a/gnu/llvm/tools/clang/docs/LibFormat.rst +++ /dev/null @@ -1,58 +0,0 @@ -========= -LibFormat -========= - -LibFormat is a library that implements automatic source code formatting based -on Clang. This documents describes the LibFormat interface and design as well -as some basic style discussions. - -If you just want to use `clang-format` as a tool or integrated into an editor, -checkout :doc:`ClangFormat`. - -Design ------- - -FIXME: Write up design. - - -Interface ---------- - -The core routine of LibFormat is ``reformat()``: - -.. code-block:: c++ - - tooling::Replacements reformat(const FormatStyle &Style, Lexer &Lex, - SourceManager &SourceMgr, - std::vector<CharSourceRange> Ranges); - -This reads a token stream out of the lexer ``Lex`` and reformats all the code -ranges in ``Ranges``. The ``FormatStyle`` controls basic decisions made during -formatting. A list of options can be found under :ref:`style-options`. - -The style options are described in :doc:`ClangFormatStyleOptions`. - - -.. _style-options: - -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: - -.. code-block:: c++ - - /// Returns a format style complying with the LLVM coding standards: - /// https://llvm.org/docs/CodingStandards.html. - FormatStyle getLLVMStyle(); - - /// Returns a format style complying with Google's C++ style guide: - /// http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml. - FormatStyle getGoogleStyle(); - -These options are also exposed in the :doc:`standalone tools <ClangFormat>` -through the `-style` option. - -In the future, we plan on making this configurable. |
