forked from OSchip/llvm-project
42 lines
930 B
ReStructuredText
42 lines
930 B
ReStructuredText
.. title:: clang-tidy - llvm-namespace-comment
|
|
|
|
llvm-namespace-comment
|
|
======================
|
|
|
|
`google-readability-namespace-comments` redirects here as an alias for this
|
|
check.
|
|
|
|
Checks that long namespaces have a closing comment.
|
|
|
|
http://llvm.org/docs/CodingStandards.html#namespace-indentation
|
|
|
|
https://google.github.io/styleguide/cppguide.html#Namespaces
|
|
|
|
.. code-block:: c++
|
|
|
|
namespace n1 {
|
|
void f();
|
|
}
|
|
|
|
// becomes
|
|
|
|
namespace n1 {
|
|
void f();
|
|
} // namespace n1
|
|
|
|
|
|
Options
|
|
-------
|
|
|
|
.. option:: ShortNamespaceLines
|
|
|
|
Requires the closing brace of the namespace definition to be followed by a
|
|
closing comment if the body of the namespace has more than
|
|
`ShortNamespaceLines` lines of code. The value is an unsigned integer that
|
|
defaults to `1U`.
|
|
|
|
.. option:: SpacesBeforeComments
|
|
|
|
An unsigned integer specifying the number of spaces before the comment
|
|
closing a namespace definition. Default is `1U`.
|