summaryrefslogtreecommitdiffstats
path: root/clang-tools-extra/clang-tidy/readability/NamespaceCommentCheck.h
diff options
context:
space:
mode:
authorAlexander Kornienko <alexfh@google.com>2015-08-27 18:01:58 +0000
committerAlexander Kornienko <alexfh@google.com>2015-08-27 18:01:58 +0000
commitf8ed0a8d358fb7016a4f3284be865c8576f98228 (patch)
tree75f134d2711fc604fdab199c6b0efb61c0ccf680 /clang-tools-extra/clang-tidy/readability/NamespaceCommentCheck.h
parent643e0ab8df312c138bed98fcafea17755ddd43d8 (diff)
downloadbcm5719-llvm-f8ed0a8d358fb7016a4f3284be865c8576f98228.tar.gz
bcm5719-llvm-f8ed0a8d358fb7016a4f3284be865c8576f98228.zip
[clang-tidy] Update docs for clang-tidy checks. NFC
Changes mostly address formatting and unification of the style. Use MarkDown style for inline code snippets and lists. Added some text for a few checks. The idea is to move most of the documentation out to separate rST files and have implementation files refer to the corresponding documentation files. llvm-svn: 246169
Diffstat (limited to 'clang-tools-extra/clang-tidy/readability/NamespaceCommentCheck.h')
-rw-r--r--clang-tools-extra/clang-tidy/readability/NamespaceCommentCheck.h3
1 files changed, 2 insertions, 1 deletions
diff --git a/clang-tools-extra/clang-tidy/readability/NamespaceCommentCheck.h b/clang-tools-extra/clang-tidy/readability/NamespaceCommentCheck.h
index b72eb65150d..1dd350e9341 100644
--- a/clang-tools-extra/clang-tidy/readability/NamespaceCommentCheck.h
+++ b/clang-tools-extra/clang-tidy/readability/NamespaceCommentCheck.h
@@ -17,9 +17,10 @@ namespace clang {
namespace tidy {
namespace readability {
-/// \brief Checks that long namespaces have a closing comment.
+/// Checks that long namespaces have a closing comment.
///
/// http://llvm.org/docs/CodingStandards.html#namespace-indentation
+///
/// http://google-styleguide.googlecode.com/svn/trunk/cppguide.html#Namespaces
class NamespaceCommentCheck : public ClangTidyCheck {
public:
OpenPOWER on IntegriCloud