diff options
| -rw-r--r-- | clang-tools-extra/clang-tidy/utils/IncludeSorter.h | 54 | ||||
| -rw-r--r-- | clang-tools-extra/clang-tidy/utils/LexerUtils.h | 4 | ||||
| -rw-r--r-- | clang-tools-extra/clang-tidy/utils/OptionsUtils.h | 2 |
3 files changed, 30 insertions, 30 deletions
diff --git a/clang-tools-extra/clang-tidy/utils/IncludeSorter.h b/clang-tools-extra/clang-tidy/utils/IncludeSorter.h index 7e941872a0c..07fa293dc3e 100644 --- a/clang-tools-extra/clang-tidy/utils/IncludeSorter.h +++ b/clang-tools-extra/clang-tidy/utils/IncludeSorter.h @@ -17,50 +17,50 @@ namespace clang { namespace tidy { namespace utils { -// Class used by IncludeSorterCallback and IncludeInserterCallback to record the -// names of the inclusions in a given source file being processed and generate -// the necessary commands to sort the inclusions according to the precedence -// enocded in IncludeKinds. +/// Class used by ``IncludeInserterCallback`` to record the names of the +/// inclusions in a given source file being processed and generate the necessary +/// commands to sort the inclusions according to the precedence encoded in +/// ``IncludeKinds``. class IncludeSorter { public: - // Supported include styles. + /// Supported include styles. enum IncludeStyle { IS_LLVM = 0, IS_Google = 1 }; - // Converts "llvm" to IS_LLVM, otherwise returns IS_Google. + /// Converts "llvm" to ``IS_LLVM``, otherwise returns ``IS_Google``. static IncludeStyle parseIncludeStyle(const std::string &Value); - // Converts IncludeStyle to string representation. + /// Converts ``IncludeStyle`` to string representation. static StringRef toString(IncludeStyle Style); - // The classifications of inclusions, in the order they should be sorted. + /// The classifications of inclusions, in the order they should be sorted. enum IncludeKinds { - IK_MainTUInclude = 0, // e.g. #include "foo.h" when editing foo.cc - IK_CSystemInclude = 1, // e.g. #include <stdio.h> - IK_CXXSystemInclude = 2, // e.g. #include <vector> - IK_NonSystemInclude = 3, // e.g. #include "bar.h" - IK_InvalidInclude = 4 // total number of valid IncludeKinds + IK_MainTUInclude = 0, ///< e.g. ``#include "foo.h"`` when editing foo.cc + IK_CSystemInclude = 1, ///< e.g. ``#include <stdio.h>`` + IK_CXXSystemInclude = 2, ///< e.g. ``#include <vector>`` + IK_NonSystemInclude = 3, ///< e.g. ``#include "bar.h"`` + IK_InvalidInclude = 4 ///< total number of valid ``IncludeKind``s }; - // IncludeSorter constructor; takes the FileID and name of the file to be - // processed by the sorter. + /// ``IncludeSorter`` constructor; takes the FileID and name of the file to be + /// processed by the sorter. IncludeSorter(const SourceManager *SourceMgr, const LangOptions *LangOpts, const FileID FileID, StringRef FileName, IncludeStyle Style); - // Returns the SourceManager-specific file ID for the file being handled by - // the sorter. + /// Returns the ``SourceManager``-specific file ID for the file being handled + /// by the sorter. const FileID current_FileID() const { return CurrentFileID; } - // Adds the given #include to the sorter. + /// Adds the given include directive to the sorter. void AddInclude(StringRef FileName, bool IsAngled, SourceLocation HashLocation, SourceLocation EndLocation); - // Returns the edits needed to sort the current set of includes and reset the - // internal state (so that different blocks of includes are sorted separately - // within the same file). + /// Returns the edits needed to sort the current set of includes and reset the + /// internal state (so that different blocks of includes are sorted separately + /// within the same file). std::vector<FixItHint> GetEdits(); - // Creates a quoted inclusion directive in the right sort order. Returns None - // on error or if header inclusion directive for header already exists. + /// Creates a quoted inclusion directive in the right sort order. Returns None + /// on error or if header inclusion directive for header already exists. Optional<FixItHint> CreateIncludeInsertion(StringRef FileName, bool IsAngled); private: @@ -70,13 +70,13 @@ private: const LangOptions *LangOpts; const IncludeStyle Style; FileID CurrentFileID; - // The file name stripped of common suffixes. + /// The file name stripped of common suffixes. StringRef CanonicalFile; - // Locations of visited include directives. + /// Locations of visited include directives. SourceRangeVector SourceLocations; - // Mapping from file name to #include locations. + /// Mapping from file name to #include locations. llvm::StringMap<SourceRangeVector> IncludeLocations; - // Includes sorted into buckets. + /// Includes sorted into buckets. SmallVector<std::string, 1> IncludeBucket[IK_InvalidInclude]; }; diff --git a/clang-tools-extra/clang-tidy/utils/LexerUtils.h b/clang-tools-extra/clang-tidy/utils/LexerUtils.h index 63469d1416c..f2185927ae3 100644 --- a/clang-tools-extra/clang-tidy/utils/LexerUtils.h +++ b/clang-tools-extra/clang-tidy/utils/LexerUtils.h @@ -18,8 +18,8 @@ namespace tidy { namespace utils { namespace lexer { -// Returns previous non-comment token skipping over any comment text or -// tok::unknown if not found. +/// Returns previous non-comment token skipping over any comment text or +/// ``tok::unknown`` if not found. Token getPreviousNonCommentToken(const ASTContext &Context, SourceLocation Location); diff --git a/clang-tools-extra/clang-tidy/utils/OptionsUtils.h b/clang-tools-extra/clang-tidy/utils/OptionsUtils.h index 83be217cf0a..d822ac98c12 100644 --- a/clang-tools-extra/clang-tidy/utils/OptionsUtils.h +++ b/clang-tools-extra/clang-tidy/utils/OptionsUtils.h @@ -21,7 +21,7 @@ namespace options { std::vector<std::string> parseStringList(StringRef Option); /// \brief Serialize a sequence of names that can be parsed by -/// 'parseStringList'. +/// ``parseStringList``. std::string serializeStringList(ArrayRef<std::string> Strings); } // namespace options |
