[clang-tools-extra] r272994 - [clang-tidy] Fix doxygen errors. NFC.
Alexander Kornienko via cfe-commits
cfe-commits at lists.llvm.org
Fri Jun 17 04:43:35 PDT 2016
Author: alexfh
Date: Fri Jun 17 06:43:33 2016
New Revision: 272994
URL: http://llvm.org/viewvc/llvm-project?rev=272994&view=rev
Log:
[clang-tidy] Fix doxygen errors. NFC.
Modified:
clang-tools-extra/trunk/clang-tidy/ClangTidy.h
clang-tools-extra/trunk/clang-tidy/modernize/DeprecatedHeadersCheck.h
clang-tools-extra/trunk/clang-tidy/readability/UniqueptrDeleteReleaseCheck.h
clang-tools-extra/trunk/clang-tidy/utils/DeclRefExprUtils.h
clang-tools-extra/trunk/clang-tidy/utils/FixItHintUtils.h
clang-tools-extra/trunk/clang-tidy/utils/HeaderFileExtensionsUtils.h
clang-tools-extra/trunk/clang-tidy/utils/HeaderGuard.h
clang-tools-extra/trunk/clang-tidy/utils/IncludeInserter.h
clang-tools-extra/trunk/clang-tidy/utils/TypeTraits.h
clang-tools-extra/trunk/docs/doxygen.cfg.in
Modified: clang-tools-extra/trunk/clang-tidy/ClangTidy.h
URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/clang-tidy/ClangTidy.h?rev=272994&r1=272993&r2=272994&view=diff
==============================================================================
--- clang-tools-extra/trunk/clang-tidy/ClangTidy.h (original)
+++ clang-tools-extra/trunk/clang-tidy/ClangTidy.h Fri Jun 17 06:43:33 2016
@@ -94,11 +94,11 @@ private:
/// base class's methods. E.g. to implement a check that validates namespace
/// declarations, override ``registerMatchers``:
///
-/// ```c++
+/// ~~~{.cpp}
/// void registerMatchers(ast_matchers::MatchFinder *Finder) override {
/// Finder->addMatcher(namespaceDecl().bind("namespace"), this);
/// }
-/// ```
+/// ~~~
///
/// and then override ``check(const MatchResult &Result)`` to do the actual
/// check for each match.
@@ -127,7 +127,7 @@ public:
/// dependent properties, e.g. the order of include directives.
virtual void registerPPCallbacks(CompilerInstance &Compiler) {}
- /// \brief Override this to register ASTMatchers with \p Finder.
+ /// \brief Override this to register AST matchers with \p Finder.
///
/// This should be used by clang-tidy checks that analyze code properties that
/// dependent on AST knowledge.
Modified: clang-tools-extra/trunk/clang-tidy/modernize/DeprecatedHeadersCheck.h
URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/clang-tidy/modernize/DeprecatedHeadersCheck.h?rev=272994&r1=272993&r2=272994&view=diff
==============================================================================
--- clang-tools-extra/trunk/clang-tidy/modernize/DeprecatedHeadersCheck.h (original)
+++ clang-tools-extra/trunk/clang-tidy/modernize/DeprecatedHeadersCheck.h Fri Jun 17 06:43:33 2016
@@ -20,11 +20,16 @@ namespace modernize {
/// alternatives.
///
/// Before:
-/// #include <header.h>
+/// ~~~{.cpp}
+/// #include <header.h>
+/// ~~~
+///
/// After:
-/// #include <cheader>
+/// ~~~{.cpp}
+/// #include <cheader>
+/// ~~~
///
-/// Example: <stdio.h> => <cstdio>
+/// Example: ``<stdio.h> => <cstdio>``
///
/// For the user-facing documentation see:
/// http://clang.llvm.org/extra/clang-tidy/checks/modernize-deprecated-headers.html
Modified: clang-tools-extra/trunk/clang-tidy/readability/UniqueptrDeleteReleaseCheck.h
URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/clang-tidy/readability/UniqueptrDeleteReleaseCheck.h?rev=272994&r1=272993&r2=272994&view=diff
==============================================================================
--- clang-tools-extra/trunk/clang-tidy/readability/UniqueptrDeleteReleaseCheck.h (original)
+++ clang-tools-extra/trunk/clang-tidy/readability/UniqueptrDeleteReleaseCheck.h Fri Jun 17 06:43:33 2016
@@ -16,8 +16,8 @@ namespace clang {
namespace tidy {
namespace readability {
-/// Flag statements of the form: delete <unique_ptr expr>.release()
-/// and replace them with: <unique_ptr expr> = nullptr
+/// Flags statements of the form ``delete <unique_ptr expr>.release();`` and
+/// replaces them with: ``<unique_ptr expr> = nullptr;``
///
/// For the user-facing documentation see:
/// http://clang.llvm.org/extra/clang-tidy/checks/readability-uniqueptr-delete-release.html
Modified: clang-tools-extra/trunk/clang-tidy/utils/DeclRefExprUtils.h
URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/clang-tidy/utils/DeclRefExprUtils.h?rev=272994&r1=272993&r2=272994&view=diff
==============================================================================
--- clang-tools-extra/trunk/clang-tidy/utils/DeclRefExprUtils.h (original)
+++ clang-tools-extra/trunk/clang-tidy/utils/DeclRefExprUtils.h Fri Jun 17 06:43:33 2016
@@ -18,11 +18,12 @@ namespace tidy {
namespace utils {
namespace decl_ref_expr {
-/// \brief Returns true if all DeclRefExpr to the variable within Stmt do not
-/// modify it.
+/// \brief Returns true if all ``DeclRefExpr`` to the variable within ``Stmt``
+/// do not modify it.
///
-/// Returns true if only const methods or operators are called on the variable
-/// or the variable is a const reference or value argument to a callExpr().
+/// Returns ``true`` if only const methods or operators are called on the
+/// variable or the variable is a const reference or value argument to a
+/// ``callExpr()``.
bool isOnlyUsedAsConst(const VarDecl &Var, const Stmt &Stmt,
ASTContext &Context);
Modified: clang-tools-extra/trunk/clang-tidy/utils/FixItHintUtils.h
URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/clang-tidy/utils/FixItHintUtils.h?rev=272994&r1=272993&r2=272994&view=diff
==============================================================================
--- clang-tools-extra/trunk/clang-tidy/utils/FixItHintUtils.h (original)
+++ clang-tools-extra/trunk/clang-tidy/utils/FixItHintUtils.h Fri Jun 17 06:43:33 2016
@@ -18,10 +18,10 @@ namespace tidy {
namespace utils {
namespace fixit {
-/// \brief Creates fix to make VarDecl a reference by adding '&'.
+/// \brief Creates fix to make ``VarDecl`` a reference by adding ``&``.
FixItHint changeVarDeclToReference(const VarDecl &Var, ASTContext &Context);
-/// \brief Creates fix to make VarDecl const qualified.
+/// \brief Creates fix to make ``VarDecl`` const qualified.
FixItHint changeVarDeclToConst(const VarDecl &Var);
} // namespace fixit
Modified: clang-tools-extra/trunk/clang-tidy/utils/HeaderFileExtensionsUtils.h
URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/clang-tidy/utils/HeaderFileExtensionsUtils.h?rev=272994&r1=272993&r2=272994&view=diff
==============================================================================
--- clang-tools-extra/trunk/clang-tidy/utils/HeaderFileExtensionsUtils.h (original)
+++ clang-tools-extra/trunk/clang-tidy/utils/HeaderFileExtensionsUtils.h Fri Jun 17 06:43:33 2016
@@ -21,17 +21,17 @@ namespace utils {
typedef llvm::SmallSet<llvm::StringRef, 5> HeaderFileExtensionsSet;
-/// \brief Checks whether expansion location of Loc is in header file.
+/// \brief Checks whether expansion location of \p Loc is in header file.
bool isExpansionLocInHeaderFile(
SourceLocation Loc, const SourceManager &SM,
const HeaderFileExtensionsSet &HeaderFileExtensions);
-/// \brief Checks whether presumed location of Loc is in header file.
+/// \brief Checks whether presumed location of \p Loc is in header file.
bool isPresumedLocInHeaderFile(
SourceLocation Loc, SourceManager &SM,
const HeaderFileExtensionsSet &HeaderFileExtensions);
-/// \brief Checks whether spelling location of Loc is in header file.
+/// \brief Checks whether spelling location of \p Loc is in header file.
bool isSpellingLocInHeaderFile(
SourceLocation Loc, SourceManager &SM,
const HeaderFileExtensionsSet &HeaderFileExtensions);
Modified: clang-tools-extra/trunk/clang-tidy/utils/HeaderGuard.h
URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/clang-tidy/utils/HeaderGuard.h?rev=272994&r1=272993&r2=272994&view=diff
==============================================================================
--- clang-tools-extra/trunk/clang-tidy/utils/HeaderGuard.h (original)
+++ clang-tools-extra/trunk/clang-tidy/utils/HeaderGuard.h Fri Jun 17 06:43:33 2016
@@ -23,20 +23,20 @@ public:
: ClangTidyCheck(Name, Context) {}
void registerPPCallbacks(CompilerInstance &Compiler) override;
- /// \brief Returns true if the checker should suggest inserting a trailing
- /// comment on the #endif of the header guard. It will use the same name as
- /// returned by getHeaderGuard.
+ /// Returns ``true`` if the check should suggest inserting a trailing comment
+ /// on the ``#endif`` of the header guard. It will use the same name as
+ /// returned by ``HeaderGuardCheck::getHeaderGuard``.
virtual bool shouldSuggestEndifComment(StringRef Filename);
- /// \brief Returns true if the checker should suggest changing an existing
- /// header guard to the string returned by getHeaderGuard.
+ /// Returns ``true`` if the check should suggest changing an existing header
+ /// guard to the string returned by ``HeaderGuardCheck::getHeaderGuard``.
virtual bool shouldFixHeaderGuard(StringRef Filename);
- /// \brief Returns true if the checker should add a header guard to the file
+ /// Returns ``true`` if the check should add a header guard to the file
/// if it has none.
virtual bool shouldSuggestToAddHeaderGuard(StringRef Filename);
- /// \brief Returns a replacement for endif line with a comment mentioning
- /// \p HeaderGuard. The replacement should start with "endif".
+ /// Returns a replacement for the ``#endif`` line with a comment mentioning
+ /// \p HeaderGuard. The replacement should start with ``endif``.
virtual std::string formatEndIf(StringRef HeaderGuard);
- /// \brief Get the canonical header guard for a file.
+ /// Gets the canonical header guard for a file.
virtual std::string getHeaderGuard(StringRef Filename,
StringRef OldGuard = StringRef()) = 0;
};
Modified: clang-tools-extra/trunk/clang-tidy/utils/IncludeInserter.h
URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/clang-tidy/utils/IncludeInserter.h?rev=272994&r1=272993&r2=272994&view=diff
==============================================================================
--- clang-tools-extra/trunk/clang-tidy/utils/IncludeInserter.h (original)
+++ clang-tools-extra/trunk/clang-tidy/utils/IncludeInserter.h Fri Jun 17 06:43:33 2016
@@ -22,40 +22,47 @@ namespace clang {
namespace tidy {
namespace utils {
-// IncludeInserter can be used by ClangTidyChecks in the following fashion:
-// class MyCheck : public ClangTidyCheck {
-// public:
-// void registerPPCallbacks(CompilerInstance& Compiler) override {
-// Inserter.reset(new IncludeInserter(&Compiler.getSourceManager(),
-// &Compiler.getLangOpts()));
-// Compiler.getPreprocessor().addPPCallbacks(
-// Inserter->CreatePPCallback());
-// }
-//
-// void registerMatchers(ast_matchers::MatchFinder* Finder) override { ... }
-//
-// void check(const ast_matchers::MatchFinder::MatchResult& Result) override {
-// ...
-// Inserter->CreateIncludeInsertion(
-// Result.SourceManager->getMainFileID(), "path/to/Header.h",
-// /*IsAngled=*/false);
-// ...
-// }
-//
-// private:
-// std::unique_ptr<IncludeInserter> Inserter;
-// };
+/// \brief Produces fixes to insert specified includes to source files, if not
+/// yet present.
+///
+/// ``IncludeInserter`` can be used by ``ClangTidyCheck`` in the following
+/// fashion:
+/// \code
+/// class MyCheck : public ClangTidyCheck {
+/// public:
+/// void registerPPCallbacks(CompilerInstance& Compiler) override {
+/// Inserter.reset(new IncludeInserter(&Compiler.getSourceManager(),
+/// &Compiler.getLangOpts()));
+/// Compiler.getPreprocessor().addPPCallbacks(
+/// Inserter->CreatePPCallback());
+/// }
+///
+/// void registerMatchers(ast_matchers::MatchFinder* Finder) override { ... }
+///
+/// void check(
+/// const ast_matchers::MatchFinder::MatchResult& Result) override {
+/// ...
+/// Inserter->CreateIncludeInsertion(
+/// Result.SourceManager->getMainFileID(), "path/to/Header.h",
+/// /*IsAngled=*/false);
+/// ...
+/// }
+///
+/// private:
+/// std::unique_ptr<IncludeInserter> Inserter;
+/// };
+/// \endcode
class IncludeInserter {
public:
IncludeInserter(const SourceManager &SourceMgr, const LangOptions &LangOpts,
IncludeSorter::IncludeStyle Style);
~IncludeInserter();
- // Create PPCallbacks for registration with the compiler's preprocessor.
+ /// Create ``PPCallbacks`` for registration with the compiler's preprocessor.
std::unique_ptr<PPCallbacks> CreatePPCallbacks();
- // Creates a Header inclusion directive fixit. Returns None on error or
- // if inclusion directive already exists.
+ /// Creates a \p Header inclusion directive fixit. Returns ``llvm::None`` on
+ /// error or if inclusion directive already exists.
llvm::Optional<FixItHint>
CreateIncludeInsertion(FileID FileID, llvm::StringRef Header, bool IsAngled);
Modified: clang-tools-extra/trunk/clang-tidy/utils/TypeTraits.h
URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/clang-tidy/utils/TypeTraits.h?rev=272994&r1=272993&r2=272994&view=diff
==============================================================================
--- clang-tools-extra/trunk/clang-tidy/utils/TypeTraits.h (original)
+++ clang-tools-extra/trunk/clang-tidy/utils/TypeTraits.h Fri Jun 17 06:43:33 2016
@@ -18,14 +18,14 @@ namespace tidy {
namespace utils {
namespace type_traits {
-// \brief Returns true If \c Type is expensive to copy.
+/// Returns `true` if `Type` is expensive to copy.
llvm::Optional<bool> isExpensiveToCopy(QualType Type,
const ASTContext &Context);
-// \brief Returns true If \c Type is trivially default constructible.
+/// Returns `true` if `Type` is trivially default constructible.
bool isTriviallyDefaultConstructible(QualType Type, const ASTContext &Context);
-// \brief Returns true If \c RecordDecl is trivially default constructible.
+/// Returns `true` if `RecordDecl` is trivially default constructible.
bool recordIsTriviallyDefaultConstructible(const RecordDecl &RecordDecl,
const ASTContext &Context);
Modified: clang-tools-extra/trunk/docs/doxygen.cfg.in
URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/docs/doxygen.cfg.in?rev=272994&r1=272993&r2=272994&view=diff
==============================================================================
--- clang-tools-extra/trunk/docs/doxygen.cfg.in (original)
+++ clang-tools-extra/trunk/docs/doxygen.cfg.in Fri Jun 17 06:43:33 2016
@@ -819,7 +819,7 @@ EXCLUDE_SYMBOLS =
# that contain example code fragments that are included (see the \include
# command).
-EXAMPLE_PATH = @abs_srcdir@/../examples
+EXAMPLE_PATH =
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
@@ -839,7 +839,7 @@ EXAMPLE_RECURSIVE = YES
# that contain images that are to be included in the documentation (see the
# \image command).
-IMAGE_PATH = @abs_srcdir@/img
+IMAGE_PATH =
# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
@@ -1913,7 +1913,8 @@ SEARCH_INCLUDES = YES
# preprocessor.
# This tag requires that the tag SEARCH_INCLUDES is set to YES.
-INCLUDE_PATH = ../include
+INCLUDE_PATH = @abs_srcdir@/../../../include \
+ @abs_srcdir@/../../../../../include
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
# patterns (like *.h and *.hpp) to filter out the header-files in the
More information about the cfe-commits
mailing list