mirror of
https://github.com/llvm/llvm-project.git
synced 2025-04-25 15:46:06 +00:00
9fc8faf9e6
This is similar to the LLVM change https://reviews.llvm.org/D46290. We've been running doxygen with the autobrief option for a couple of years now. This makes the \brief markers into our comments redundant. Since they are a visual distraction and we don't want to encourage more \brief markers in new code either, this patch removes them all. Patch produced by for i in $(git grep -l '\@brief'); do perl -pi -e 's/\@brief //g' $i & done for i in $(git grep -l '\\brief'); do perl -pi -e 's/\\brief //g' $i & done Differential Revision: https://reviews.llvm.org/D46320 llvm-svn: 331834
59 lines
1.7 KiB
ReStructuredText
59 lines
1.7 KiB
ReStructuredText
=========
|
|
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:
|
|
/// http://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.
|