diff options
Diffstat (limited to 'llvm/tools')
49 files changed, 190 insertions, 190 deletions
diff --git a/llvm/tools/llvm-config/llvm-config.cpp b/llvm/tools/llvm-config/llvm-config.cpp index bb395a0a789..376dddb3590 100644 --- a/llvm/tools/llvm-config/llvm-config.cpp +++ b/llvm/tools/llvm-config/llvm-config.cpp @@ -62,7 +62,7 @@ enum LinkMode { LinkModeStatic = 2, }; -/// \brief Traverse a single component adding to the topological ordering in +/// Traverse a single component adding to the topological ordering in /// \arg RequiredLibs. /// /// \param Name - The component to traverse. @@ -129,7 +129,7 @@ static void VisitComponent(const std::string &Name, } } -/// \brief Compute the list of required libraries for a given list of +/// Compute the list of required libraries for a given list of /// components, in an order suitable for passing to a linker (that is, libraries /// appear prior to their dependencies). /// @@ -223,7 +223,7 @@ Typical components:\n\ exit(1); } -/// \brief Compute the path to the main executable. +/// Compute the path to the main executable. std::string GetExecutablePath(const char *Argv0) { // This just needs to be some symbol in the binary; C++ doesn't // allow taking the address of ::main however. @@ -231,7 +231,7 @@ std::string GetExecutablePath(const char *Argv0) { return llvm::sys::fs::getMainExecutable(Argv0, P); } -/// \brief Expand the semi-colon delimited LLVM_DYLIB_COMPONENTS into +/// Expand the semi-colon delimited LLVM_DYLIB_COMPONENTS into /// the full list of components. std::vector<std::string> GetAllDyLibComponents(const bool IsInDevelopmentTree, const bool GetComponentNames, diff --git a/llvm/tools/llvm-cov/CodeCoverage.cpp b/llvm/tools/llvm-cov/CodeCoverage.cpp index 430cb0b50c9..e40cc5c386e 100644 --- a/llvm/tools/llvm-cov/CodeCoverage.cpp +++ b/llvm/tools/llvm-cov/CodeCoverage.cpp @@ -49,66 +49,66 @@ void exportCoverageDataToJson(const coverage::CoverageMapping &CoverageMapping, raw_ostream &OS); namespace { -/// \brief The implementation of the coverage tool. +/// The implementation of the coverage tool. class CodeCoverageTool { public: enum Command { - /// \brief The show command. + /// The show command. Show, - /// \brief The report command. + /// The report command. Report, - /// \brief The export command. + /// The export command. Export }; int run(Command Cmd, int argc, const char **argv); private: - /// \brief Print the error message to the error output stream. + /// Print the error message to the error output stream. void error(const Twine &Message, StringRef Whence = ""); - /// \brief Print the warning message to the error output stream. + /// Print the warning message to the error output stream. void warning(const Twine &Message, StringRef Whence = ""); - /// \brief Convert \p Path into an absolute path and append it to the list + /// Convert \p Path into an absolute path and append it to the list /// of collected paths. void addCollectedPath(const std::string &Path); - /// \brief If \p Path is a regular file, collect the path. If it's a + /// If \p Path is a regular file, collect the path. If it's a /// directory, recursively collect all of the paths within the directory. void collectPaths(const std::string &Path); - /// \brief Return a memory buffer for the given source file. + /// Return a memory buffer for the given source file. ErrorOr<const MemoryBuffer &> getSourceFile(StringRef SourceFile); - /// \brief Create source views for the expansions of the view. + /// Create source views for the expansions of the view. void attachExpansionSubViews(SourceCoverageView &View, ArrayRef<ExpansionRecord> Expansions, const CoverageMapping &Coverage); - /// \brief Create the source view of a particular function. + /// Create the source view of a particular function. std::unique_ptr<SourceCoverageView> createFunctionView(const FunctionRecord &Function, const CoverageMapping &Coverage); - /// \brief Create the main source view of a particular source file. + /// Create the main source view of a particular source file. std::unique_ptr<SourceCoverageView> createSourceFileView(StringRef SourceFile, const CoverageMapping &Coverage); - /// \brief Load the coverage mapping data. Return nullptr if an error occurred. + /// Load the coverage mapping data. Return nullptr if an error occurred. std::unique_ptr<CoverageMapping> load(); - /// \brief Create a mapping from files in the Coverage data to local copies + /// Create a mapping from files in the Coverage data to local copies /// (path-equivalence). void remapPathNames(const CoverageMapping &Coverage); - /// \brief Remove input source files which aren't mapped by \p Coverage. + /// Remove input source files which aren't mapped by \p Coverage. void removeUnmappedInputs(const CoverageMapping &Coverage); - /// \brief If a demangler is available, demangle all symbol names. + /// If a demangler is available, demangle all symbol names. void demangleSymbols(const CoverageMapping &Coverage); - /// \brief Write out a source file view to the filesystem. + /// Write out a source file view to the filesystem. void writeSourceFileView(StringRef SourceFile, CoverageMapping *Coverage, CoveragePrinter *Printer, bool ShowFilenames); diff --git a/llvm/tools/llvm-cov/CoverageExporter.h b/llvm/tools/llvm-cov/CoverageExporter.h index 898e9755652..884fba96d61 100644 --- a/llvm/tools/llvm-cov/CoverageExporter.h +++ b/llvm/tools/llvm-cov/CoverageExporter.h @@ -21,16 +21,16 @@ namespace llvm { -/// \brief Exports the code coverage information. +/// Exports the code coverage information. class CoverageExporter { protected: - /// \brief The full CoverageMapping object to export. + /// The full CoverageMapping object to export. const coverage::CoverageMapping &Coverage; - /// \brief The options passed to the tool. + /// The options passed to the tool. const CoverageViewOptions &Options; - /// \brief Output stream to print JSON to. + /// Output stream to print JSON to. raw_ostream &OS; CoverageExporter(const coverage::CoverageMapping &CoverageMapping, @@ -40,10 +40,10 @@ protected: public: virtual ~CoverageExporter(){}; - /// \brief Render the CoverageMapping object. + /// Render the CoverageMapping object. virtual void renderRoot(const CoverageFilters &IgnoreFilenameFilters) = 0; - /// \brief Render the CoverageMapping object for specified source files. + /// Render the CoverageMapping object for specified source files. virtual void renderRoot(const std::vector<std::string> &SourceFiles) = 0; }; diff --git a/llvm/tools/llvm-cov/CoverageExporterJson.cpp b/llvm/tools/llvm-cov/CoverageExporterJson.cpp index fc631ac6d83..56c3a0003b0 100644 --- a/llvm/tools/llvm-cov/CoverageExporterJson.cpp +++ b/llvm/tools/llvm-cov/CoverageExporterJson.cpp @@ -44,10 +44,10 @@ #include "CoverageExporterJson.h" #include "CoverageReport.h" -/// \brief The semantic version combined as a string. +/// The semantic version combined as a string. #define LLVM_COVERAGE_EXPORT_JSON_STR "2.0.0" -/// \brief Unique type identifier for JSON coverage export. +/// Unique type identifier for JSON coverage export. #define LLVM_COVERAGE_EXPORT_JSON_TYPE_STR "llvm.coverage.json.export" using namespace llvm; diff --git a/llvm/tools/llvm-cov/CoverageExporterJson.h b/llvm/tools/llvm-cov/CoverageExporterJson.h index afab8a89e29..f88dffa0ebe 100644 --- a/llvm/tools/llvm-cov/CoverageExporterJson.h +++ b/llvm/tools/llvm-cov/CoverageExporterJson.h @@ -20,28 +20,28 @@ namespace llvm { class CoverageExporterJson : public CoverageExporter { - /// \brief States that the JSON rendering machine can be in. + /// States that the JSON rendering machine can be in. enum JsonState { None, NonEmptyElement, EmptyElement }; - /// \brief Tracks state of the JSON output. + /// Tracks state of the JSON output. std::stack<JsonState> State; - /// \brief Emit a serialized scalar. + /// Emit a serialized scalar. void emitSerialized(const int64_t Value); - /// \brief Emit a serialized string. + /// Emit a serialized string. void emitSerialized(const std::string &Value); - /// \brief Emit a comma if there is a previous element to delimit. + /// Emit a comma if there is a previous element to delimit. void emitComma(); - /// \brief Emit a starting dictionary/object character. + /// Emit a starting dictionary/object character. void emitDictStart(); - /// \brief Emit a dictionary/object key but no value. + /// Emit a dictionary/object key but no value. void emitDictKey(const std::string &Key); - /// \brief Emit a dictionary/object key/value pair. + /// Emit a dictionary/object key/value pair. template <typename V> void emitDictElement(const std::string &Key, const V &Value) { emitComma(); @@ -50,60 +50,60 @@ class CoverageExporterJson : public CoverageExporter { emitSerialized(Value); } - /// \brief Emit a closing dictionary/object character. + /// Emit a closing dictionary/object character. void emitDictEnd(); - /// \brief Emit a starting array character. + /// Emit a starting array character. void emitArrayStart(); - /// \brief Emit an array element. + /// Emit an array element. template <typename V> void emitArrayElement(const V &Value) { emitComma(); emitSerialized(Value); } - /// \brief emit a closing array character. + /// emit a closing array character. void emitArrayEnd(); - /// \brief Render an array of all the given functions. + /// Render an array of all the given functions. void renderFunctions( const iterator_range<coverage::FunctionRecordIterator> &Functions); - /// \brief Render an array of all the source files, also pass back a Summary. + /// Render an array of all the source files, also pass back a Summary. void renderFiles(ArrayRef<std::string> SourceFiles, ArrayRef<FileCoverageSummary> FileReports); - /// \brief Render a single file. + /// Render a single file. void renderFile(const std::string &Filename, const FileCoverageSummary &FileReport); - /// \brief Render summary for a single file. + /// Render summary for a single file. void renderFileCoverage(const coverage::CoverageData &FileCoverage, const FileCoverageSummary &FileReport); - /// \brief Render a CoverageSegment. + /// Render a CoverageSegment. void renderSegment(const coverage::CoverageSegment &Segment); - /// \brief Render an ExpansionRecord. + /// Render an ExpansionRecord. void renderExpansion(const coverage::ExpansionRecord &Expansion); - /// \brief Render a list of CountedRegions. + /// Render a list of CountedRegions. void renderRegions(ArrayRef<coverage::CountedRegion> Regions); - /// \brief Render a single CountedRegion. + /// Render a single CountedRegion. void renderRegion(const coverage::CountedRegion &Region); - /// \brief Render a FileCoverageSummary. + /// Render a FileCoverageSummary. void renderSummary(const FileCoverageSummary &Summary); public: CoverageExporterJson(const coverage::CoverageMapping &CoverageMapping, const CoverageViewOptions &Options, raw_ostream &OS); - /// \brief Render the CoverageMapping object. + /// Render the CoverageMapping object. void renderRoot(const CoverageFilters &IgnoreFilenameFilters) override; - /// \brief Render the CoverageMapping object for specified source files. + /// Render the CoverageMapping object for specified source files. void renderRoot(const std::vector<std::string> &SourceFiles) override; }; diff --git a/llvm/tools/llvm-cov/CoverageFilters.h b/llvm/tools/llvm-cov/CoverageFilters.h index eacc6d2d489..6424ca5a808 100644 --- a/llvm/tools/llvm-cov/CoverageFilters.h +++ b/llvm/tools/llvm-cov/CoverageFilters.h @@ -22,24 +22,24 @@ namespace llvm { -/// \brief Matches specific functions that pass the requirement of this filter. +/// Matches specific functions that pass the requirement of this filter. class CoverageFilter { public: virtual ~CoverageFilter() {} - /// \brief Return true if the function passes the requirements of this filter. + /// Return true if the function passes the requirements of this filter. virtual bool matches(const coverage::CoverageMapping &CM, const coverage::FunctionRecord &Function) const { return true; } - /// \brief Return true if the filename passes the requirements of this filter. + /// Return true if the filename passes the requirements of this filter. virtual bool matchesFilename(StringRef Filename) const { return true; } }; -/// \brief Matches functions that contain a specific string in their name. +/// Matches functions that contain a specific string in their name. class NameCoverageFilter : public CoverageFilter { StringRef Name; @@ -50,7 +50,7 @@ public: const coverage::FunctionRecord &Function) const override; }; -/// \brief Matches functions whose name matches a certain regular expression. +/// Matches functions whose name matches a certain regular expression. class NameRegexCoverageFilter : public CoverageFilter { StringRef Regex; @@ -63,7 +63,7 @@ public: bool matchesFilename(StringRef Filename) const override; }; -/// \brief Matches functions whose name appears in a SpecialCaseList in the +/// Matches functions whose name appears in a SpecialCaseList in the /// whitelist_fun section. class NameWhitelistCoverageFilter : public CoverageFilter { const SpecialCaseList &Whitelist; @@ -76,7 +76,7 @@ public: const coverage::FunctionRecord &Function) const override; }; -/// \brief Matches numbers that pass a certain threshold. +/// Matches numbers that pass a certain threshold. template <typename T> class StatisticThresholdFilter { public: enum Operation { LessThan, GreaterThan }; @@ -88,7 +88,7 @@ protected: StatisticThresholdFilter(Operation Op, T Threshold) : Op(Op), Threshold(Threshold) {} - /// \brief Return true if the given number is less than + /// Return true if the given number is less than /// or greater than the certain threshold. bool PassesThreshold(T Value) const { switch (Op) { @@ -101,7 +101,7 @@ protected: } }; -/// \brief Matches functions whose region coverage percentage +/// Matches functions whose region coverage percentage /// is above/below a certain percentage. class RegionCoverageFilter : public CoverageFilter, public StatisticThresholdFilter<double> { @@ -113,7 +113,7 @@ public: const coverage::FunctionRecord &Function) const override; }; -/// \brief Matches functions whose line coverage percentage +/// Matches functions whose line coverage percentage /// is above/below a certain percentage. class LineCoverageFilter : public CoverageFilter, public StatisticThresholdFilter<double> { @@ -125,7 +125,7 @@ public: const coverage::FunctionRecord &Function) const override; }; -/// \brief A collection of filters. +/// A collection of filters. /// Matches functions that match any filters contained /// in an instance of this class. class CoverageFilters : public CoverageFilter { @@ -133,7 +133,7 @@ protected: std::vector<std::unique_ptr<CoverageFilter>> Filters; public: - /// \brief Append a filter to this collection. + /// Append a filter to this collection. void push_back(std::unique_ptr<CoverageFilter> Filter); bool empty() const { return Filters.empty(); } @@ -144,7 +144,7 @@ public: bool matchesFilename(StringRef Filename) const override; }; -/// \brief A collection of filters. +/// A collection of filters. /// Matches functions that match all of the filters contained /// in an instance of this class. class CoverageFiltersMatchAll : public CoverageFilters { diff --git a/llvm/tools/llvm-cov/CoverageReport.cpp b/llvm/tools/llvm-cov/CoverageReport.cpp index 5d892202f0d..607a3ceb30c 100644 --- a/llvm/tools/llvm-cov/CoverageReport.cpp +++ b/llvm/tools/llvm-cov/CoverageReport.cpp @@ -24,7 +24,7 @@ using namespace llvm; namespace { -/// \brief Helper struct which prints trimmed and aligned columns. +/// Helper struct which prints trimmed and aligned columns. struct Column { enum TrimKind { NoTrim, WidthTrim, RightTrim }; @@ -91,7 +91,7 @@ size_t FileReportColumns[] = {25, 12, 18, 10, 12, 18, 10, 16, 16, 10, 12, 18, 10}; size_t FunctionReportColumns[] = {25, 10, 8, 8, 10, 8, 8}; -/// \brief Adjust column widths to fit long file paths and function names. +/// Adjust column widths to fit long file paths and function names. void adjustColumnWidths(ArrayRef<StringRef> Files, ArrayRef<StringRef> Functions) { for (StringRef Filename : Files) @@ -101,7 +101,7 @@ void adjustColumnWidths(ArrayRef<StringRef> Files, std::max(FunctionReportColumns[0], Funcname.size()); } -/// \brief Prints a horizontal divider long enough to cover the given column +/// Prints a horizontal divider long enough to cover the given column /// widths. void renderDivider(ArrayRef<size_t> ColumnWidths, raw_ostream &OS) { size_t Length = std::accumulate(ColumnWidths.begin(), ColumnWidths.end(), 0); @@ -109,7 +109,7 @@ void renderDivider(ArrayRef<size_t> ColumnWidths, raw_ostream &OS) { OS << '-'; } -/// \brief Return the color which correponds to the coverage percentage of a +/// Return the color which correponds to the coverage percentage of a /// certain metric. template <typename T> raw_ostream::Colors determineCoveragePercentageColor(const T &Info) { @@ -119,7 +119,7 @@ raw_ostream::Colors determineCoveragePercentageColor(const T &Info) { : raw_ostream::RED; } -/// \brief Get the number of redundant path components in each path in \p Paths. +/// Get the number of redundant path components in each path in \p Paths. unsigned getNumRedundantPathComponents(ArrayRef<std::string> Paths) { // To start, set the number of redundant path components to the maximum // possible value. @@ -148,7 +148,7 @@ unsigned getNumRedundantPathComponents(ArrayRef<std::string> Paths) { return NumRedundant; } -/// \brief Determine the length of the longest redundant prefix of the paths in +/// Determine the length of the longest redundant prefix of the paths in /// \p Paths. unsigned getRedundantPrefixLen(ArrayRef<std::string> Paths) { // If there's at most one path, no path components are redundant. diff --git a/llvm/tools/llvm-cov/CoverageReport.h b/llvm/tools/llvm-cov/CoverageReport.h index 8864d309fe9..4a6527e9fe5 100644 --- a/llvm/tools/llvm-cov/CoverageReport.h +++ b/llvm/tools/llvm-cov/CoverageReport.h @@ -20,7 +20,7 @@ namespace llvm { -/// \brief Displays the code coverage report. +/// Displays the code coverage report. class CoverageReport { const CoverageViewOptions &Options; const coverage::CoverageMapping &Coverage; diff --git a/llvm/tools/llvm-cov/CoverageSummaryInfo.h b/llvm/tools/llvm-cov/CoverageSummaryInfo.h index 1235350b91b..0845e2ce2e7 100644 --- a/llvm/tools/llvm-cov/CoverageSummaryInfo.h +++ b/llvm/tools/llvm-cov/CoverageSummaryInfo.h @@ -20,12 +20,12 @@ namespace llvm { -/// \brief Provides information about region coverage for a function/file. +/// Provides information about region coverage for a function/file. class RegionCoverageInfo { - /// \brief The number of regions that were executed at least once. + /// The number of regions that were executed at least once. size_t Covered; - /// \brief The total number of regions in a function/file. + /// The total number of regions in a function/file. size_t NumRegions; public: @@ -61,12 +61,12 @@ public: } }; -/// \brief Provides information about line coverage for a function/file. +/// Provides information about line coverage for a function/file. class LineCoverageInfo { - /// \brief The number of lines that were executed at least once. + /// The number of lines that were executed at least once. size_t Covered; - /// \brief The total number of lines in a function/file. + /// The total number of lines in a function/file. size_t NumLines; public: @@ -102,12 +102,12 @@ public: } }; -/// \brief Provides information about function coverage for a file. +/// Provides information about function coverage for a file. class FunctionCoverageInfo { - /// \brief The number of functions that were executed. + /// The number of functions that were executed. size_t Executed; - /// \brief The total number of functions in this file. + /// The total number of functions in this file. size_t NumFunctions; public: @@ -142,7 +142,7 @@ public: } }; -/// \brief A summary of function's code coverage. +/// A summary of function's code coverage. struct FunctionCoverageSummary { std::string Name; uint64_t ExecutionCount; @@ -158,7 +158,7 @@ struct FunctionCoverageSummary { : Name(Name), ExecutionCount(ExecutionCount), RegionCoverage(RegionCoverage), LineCoverage(LineCoverage) {} - /// \brief Compute the code coverage summary for the given function coverage + /// Compute the code coverage summary for the given function coverage /// mapping record. static FunctionCoverageSummary get(const coverage::CoverageMapping &CM, const coverage::FunctionRecord &Function); @@ -170,7 +170,7 @@ struct FunctionCoverageSummary { ArrayRef<FunctionCoverageSummary> Summaries); }; -/// \brief A summary of file's code coverage. +/// A summary of file's code coverage. struct FileCoverageSummary { StringRef Name; RegionCoverageInfo RegionCoverage; @@ -201,11 +201,11 @@ struct FileCoverageSummary { } }; -/// \brief A cache for demangled symbols. +/// A cache for demangled symbols. struct DemangleCache { StringMap<std::string> DemangledNames; - /// \brief Demangle \p Sym if possible. Otherwise, just return \p Sym. + /// Demangle \p Sym if possible. Otherwise, just return \p Sym. StringRef demangle(StringRef Sym) const { const auto DemangledName = DemangledNames.find(Sym); if (DemangledName == DemangledNames.end()) diff --git a/llvm/tools/llvm-cov/CoverageViewOptions.h b/llvm/tools/llvm-cov/CoverageViewOptions.h index fbd230299a2..20085a957bb 100644 --- a/llvm/tools/llvm-cov/CoverageViewOptions.h +++ b/llvm/tools/llvm-cov/CoverageViewOptions.h @@ -16,7 +16,7 @@ namespace llvm { -/// \brief The options for displaying the code coverage information. +/// The options for displaying the code coverage information. struct CoverageViewOptions { enum class OutputFormat { Text, @@ -42,25 +42,25 @@ struct CoverageViewOptions { std::string CreatedTimeStr; unsigned NumThreads; - /// \brief Change the output's stream color if the colors are enabled. + /// Change the output's stream color if the colors are enabled. ColoredRawOstream colored_ostream(raw_ostream &OS, raw_ostream::Colors Color) const { return llvm::colored_ostream(OS, Color, Colors); } - /// \brief Check if an output directory has been specified. + /// Check if an output directory has been specified. bool hasOutputDirectory() const { return !ShowOutputDirectory.empty(); } - /// \brief Check if a demangler has been specified. + /// Check if a demangler has been specified. bool hasDemangler() const { return !DemanglerOpts.empty(); } - /// \brief Check if a project title has been specified. + /// Check if a project title has been specified. bool hasProjectTitle() const { return !ProjectTitle.empty(); } - /// \brief Check if the created time of the profile data file is available. + /// Check if the created time of the profile data file is available. bool hasCreatedTime() const { return !CreatedTimeStr.empty(); } - /// \brief Get the LLVM version string. + /// Get the LLVM version string. std::string getLLVMVersionString() const { std::string VersionString = "Generated by llvm-cov -- llvm version "; VersionString += LLVM_VERSION_STRING; diff --git a/llvm/tools/llvm-cov/RenderingSupport.h b/llvm/tools/llvm-cov/RenderingSupport.h index aa70fbc23e3..2cfe2491914 100644 --- a/llvm/tools/llvm-cov/RenderingSupport.h +++ b/llvm/tools/llvm-cov/RenderingSupport.h @@ -15,7 +15,7 @@ namespace llvm { -/// \brief A helper class that resets the output stream's color if needed +/// A helper class that resets the output stream's color if needed /// when destroyed. class ColoredRawOstream { ColoredRawOstream(const ColoredRawOstream &OS) = delete; @@ -45,7 +45,7 @@ inline raw_ostream &operator<<(const ColoredRawOstream &OS, T &&Value) { return OS.OS << std::forward<T>(Value); } -/// \brief Change the color of the output stream if the `IsColorUsed` flag +/// Change the color of the output stream if the `IsColorUsed` flag /// is true. Returns an object that resets the color when destroyed. inline ColoredRawOstream colored_ostream(raw_ostream &OS, raw_ostream::Colors Color, diff --git a/llvm/tools/llvm-cov/SourceCoverageView.h b/llvm/tools/llvm-cov/SourceCoverageView.h index 7f58ea5d7be..e3a2f9e5c0b 100644 --- a/llvm/tools/llvm-cov/SourceCoverageView.h +++ b/llvm/tools/llvm-cov/SourceCoverageView.h @@ -27,7 +27,7 @@ using namespace coverage; class CoverageFiltersMatchAll; class SourceCoverageView; -/// \brief A view that represents a macro or include expansion. +/// A view that represents a macro or include expansion. struct ExpansionView { CounterMappingRegion Region; std::unique_ptr<SourceCoverageView> View; @@ -52,7 +52,7 @@ struct ExpansionView { } }; -/// \brief A view that represents a function instantiation. +/// A view that represents a function instantiation. struct InstantiationView { StringRef FunctionName; unsigned Line; @@ -68,7 +68,7 @@ struct InstantiationView { } }; -/// \brief A file manager that handles format-aware file creation. +/// A file manager that handles format-aware file creation. class CoveragePrinter { public: struct StreamDestructor { @@ -82,18 +82,18 @@ protected: CoveragePrinter(const CoverageViewOptions &Opts) : Opts(Opts) {} - /// \brief Return `OutputDir/ToplevelDir/Path.Extension`. If \p InToplevel is + /// Return `OutputDir/ToplevelDir/Path.Extension`. If \p InToplevel is /// false, skip the ToplevelDir component. If \p Relative is false, skip the /// OutputDir component. std::string getOutputPath(StringRef Path, StringRef Extension, bool InToplevel, bool Relative = true) const; - /// \brief If directory output is enabled, create a file in that directory + /// If directory output is enabled, create a file in that directory /// at the path given by getOutputPath(). Otherwise, return stdout. Expected<OwnedStream> createOutputStream(StringRef Path, StringRef Extension, bool InToplevel) const; - /// \brief Return the sub-directory name for file coverage reports. + /// Return the sub-directory name for file coverage reports. static StringRef getCoverageDir() { return "coverage"; } public: @@ -105,14 +105,14 @@ public: /// @name File Creation Interface /// @{ - /// \brief Create a file to print a coverage view into. + /// Create a file to print a coverage view into. virtual Expected<OwnedStream> createViewFile(StringRef Path, bool InToplevel) = 0; - /// \brief Close a file which has been used to print a coverage view. + /// Close a file which has been used to print a coverage view. virtual void closeViewFile(OwnedStream OS) = 0; - /// \brief Create an index which lists reports for the given source files. + /// Create an index which lists reports for the given source files. virtual Error createIndexFile(ArrayRef<std::string> SourceFiles, const CoverageMapping &Coverage, const CoverageFiltersMatchAll &Filters) = 0; @@ -120,7 +120,7 @@ public: /// @} }; -/// \brief A code coverage view of a source file or function. +/// A code coverage view of a source file or function. /// /// A source coverage view and its nested sub-views form a file-oriented /// representation of code coverage data. This view can be printed out by a @@ -161,73 +161,73 @@ protected: /// @name Rendering Interface /// @{ - /// \brief Render a header for the view. + /// Render a header for the view. virtual void renderViewHeader(raw_ostream &OS) = 0; - /// \brief Render a footer for the view. + /// Render a footer for the view. virtual void renderViewFooter(raw_ostream &OS) = 0; - /// \brief Render the source name for the view. + /// Render the source name for the view. virtual void renderSourceName(raw_ostream &OS, bool WholeFile) = 0; - /// \brief Render the line prefix at the given \p ViewDepth. + /// Render the line prefix at the given \p ViewDepth. virtual void renderLinePrefix(raw_ostream &OS, unsigned ViewDepth) = 0; - /// \brief Render the line suffix at the given \p ViewDepth. + /// Render the line suffix at the given \p ViewDepth. virtual void renderLineSuffix(raw_ostream &OS, unsigned ViewDepth) = 0; - /// \brief Render a view divider at the given \p ViewDepth. + /// Render a view divider at the given \p ViewDepth. virtual void renderViewDivider(raw_ostream &OS, unsigned ViewDepth) = 0; - /// \brief Render a source line with highlighting. + /// Render a source line with highlighting. virtual void renderLine(raw_ostream &OS, LineRef L, const LineCoverageStats &LCS, unsigned ExpansionCol, unsigned ViewDepth) = 0; - /// \brief Render the line's execution count column. + /// Render the line's execution count column. virtual void renderLineCoverageColumn(raw_ostream &OS, const LineCoverageStats &Line) = 0; - /// \brief Render the line number column. + /// Render the line number column. virtual void renderLineNumberColumn(raw_ostream &OS, unsigned LineNo) = 0; - /// \brief Render all the region's execution counts on a line. + /// Render all the region's execution counts on a line. virtual void renderRegionMarkers(raw_ostream &OS, const LineCoverageStats &Line, unsigned ViewDepth) = 0; - /// \brief Render the site of an expansion. + /// Render the site of an expansion. virtual void renderExpansionSite(raw_ostream &OS, LineRef L, const LineCoverageStats &LCS, unsigned ExpansionCol, unsigned ViewDepth) = 0; - /// \brief Render an expansion view and any nested views. + /// Render an expansion view and any nested views. virtual void renderExpansionView(raw_ostream &OS, ExpansionView &ESV, unsigned ViewDepth) = 0; - /// \brief Render an instantiation view and any nested views. + /// Render an instantiation view and any nested views. virtual void renderInstantiationView(raw_ostream &OS, InstantiationView &ISV, unsigned ViewDepth) = 0; - /// \brief Render \p Title, a project title if one is available, and the + /// Render \p Title, a project title if one is available, and the /// created time. virtual void renderTitle(raw_ostream &OS, StringRef CellText) = 0; - /// \brief Render the table header for a given source file. + /// Render the table header for a given source file. virtual void renderTableHeader(raw_ostream &OS, unsigned FirstUncoveredLineNo, unsigned IndentLevel) = 0; /// @} - /// \brief Format a count using engineering notation with 3 significant + /// Format a count using engineering notation with 3 significant /// digits. static std::string formatCount(uint64_t N); - /// \brief Check if region marker output is expected for a line. + /// Check if region marker output is expected for a line. bool shouldRenderRegionMarkers(const LineCoverageStats &LCS) const; - /// \brief Check if there are any sub-views attached to this view. + /// Check if there are any sub-views attached to this view. bool hasSubViews() const; SourceCoverageView(StringRef SourceName, const MemoryBuffer &File, @@ -243,20 +243,20 @@ public: virtual ~SourceCoverageView() {} - /// \brief Return the source name formatted for the host OS. + /// Return the source name formatted for the host OS. std::string getSourceName() const; const CoverageViewOptions &getOptions() const { return Options; } - /// \brief Add an expansion subview to this view. + /// Add an expansion subview to this view. void addExpansion(const CounterMappingRegion &Region, std::unique_ptr<SourceCoverageView> View); - /// \brief Add a function instantiation subview to this view. + /// Add a function instantiation subview to this view. void addInstantiation(StringRef FunctionName, unsigned Line, std::unique_ptr<SourceCoverageView> View); - /// \brief Print the code coverage information for a specific portion of a + /// Print the code coverage information for a specific portion of a /// source file to the output stream. void print(raw_ostream &OS, bool WholeFile, bool ShowSourceName, bool ShowTitle, unsigned ViewDepth = 0); diff --git a/llvm/tools/llvm-cov/SourceCoverageViewHTML.h b/llvm/tools/llvm-cov/SourceCoverageViewHTML.h index 91b4ad4e220..cb41fcaf37b 100644 --- a/llvm/tools/llvm-cov/SourceCoverageViewHTML.h +++ b/llvm/tools/llvm-cov/SourceCoverageViewHTML.h @@ -22,7 +22,7 @@ using namespace coverage; struct FileCoverageSummary; -/// \brief A coverage printer for html output. +/// A coverage printer for html output. class CoveragePrinterHTML : public CoveragePrinter { public: Expected<OwnedStream> createViewFile(StringRef Path, @@ -45,7 +45,7 @@ private: const FileCoverageSummary &FCS) const; }; -/// \brief A code coverage view which supports html-based rendering. +/// A code coverage view which supports html-based rendering. class SourceCoverageViewHTML : public SourceCoverageView { void renderViewHeader(raw_ostream &OS) override; diff --git a/llvm/tools/llvm-cov/SourceCoverageViewText.cpp b/llvm/tools/llvm-cov/SourceCoverageViewText.cpp index 2480ee9f416..aac70baed61 100644 --- a/llvm/tools/llvm-cov/SourceCoverageViewText.cpp +++ b/llvm/tools/llvm-cov/SourceCoverageViewText.cpp @@ -51,13 +51,13 @@ namespace { static const unsigned LineCoverageColumnWidth = 7; static const unsigned LineNumberColumnWidth = 5; -/// \brief Get the width of the leading columns. +/// Get the width of the leading columns. unsigned getCombinedColumnWidth(const CoverageViewOptions &Opts) { return (Opts.ShowLineStats ? LineCoverageColumnWidth + 1 : 0) + (Opts.ShowLineNumbers ? LineNumberColumnWidth + 1 : 0); } -/// \brief The width of the line that is used to divide between the view and +/// The width of the line that is used to divide between the view and /// the subviews. unsigned getDividerWidth(const CoverageViewOptions &Opts) { return getCombinedColumnWidth(Opts) + 4; diff --git a/llvm/tools/llvm-cov/SourceCoverageViewText.h b/llvm/tools/llvm-cov/SourceCoverageViewText.h index cabf91975df..a46f35cc649 100644 --- a/llvm/tools/llvm-cov/SourceCoverageViewText.h +++ b/llvm/tools/llvm-cov/SourceCoverageViewText.h @@ -20,7 +20,7 @@ namespace llvm { using namespace coverage; -/// \brief A coverage printer for text output. +/// A coverage printer for text output. class CoveragePrinterText : public CoveragePrinter { public: Expected<OwnedStream> createViewFile(StringRef Path, @@ -36,7 +36,7 @@ public: : CoveragePrinter(Opts) {} }; -/// \brief A code coverage view which supports text-based rendering. +/// A code coverage view which supports text-based rendering. class SourceCoverageViewText : public SourceCoverageView { void renderViewHeader(raw_ostream &OS) override; diff --git a/llvm/tools/llvm-cov/llvm-cov.cpp b/llvm/tools/llvm-cov/llvm-cov.cpp index 93066fc0c15..4c3b574451c 100644 --- a/llvm/tools/llvm-cov/llvm-cov.cpp +++ b/llvm/tools/llvm-cov/llvm-cov.cpp @@ -23,22 +23,22 @@ using namespace llvm; -/// \brief The main entry point for the 'show' subcommand. +/// The main entry point for the 'show' subcommand. int showMain(int argc, const char *argv[]); -/// \brief The main entry point for the 'report' subcommand. +/// The main entry point for the 'report' subcommand. int reportMain(int argc, const char *argv[]); -/// \brief The main entry point for the 'export' subcommand. +/// The main entry point for the 'export' subcommand. int exportMain(int argc, const char *argv[]); -/// \brief The main entry point for the 'convert-for-testing' subcommand. +/// The main entry point for the 'convert-for-testing' subcommand. int convertForTestingMain(int argc, const char *argv[]); -/// \brief The main entry point for the gcov compatible coverage tool. +/// The main entry point for the gcov compatible coverage tool. int gcovMain(int argc, const char *argv[]); -/// \brief Top level help. +/// Top level help. static int helpMain(int argc, const char *argv[]) { errs() << "Usage: llvm-cov {export|gcov|report|show} [OPTION]...\n\n" << "Shows code coverage information.\n\n" @@ -51,7 +51,7 @@ static int helpMain(int argc, const char *argv[]) { return 0; } -/// \brief Top level version information. +/// Top level version information. static int versionMain(int argc, const char *argv[]) { cl::PrintVersionMessage(); return 0; diff --git a/llvm/tools/llvm-dwarfdump/fuzzer/llvm-dwarfdump-fuzzer.cpp b/llvm/tools/llvm-dwarfdump/fuzzer/llvm-dwarfdump-fuzzer.cpp index 53c74df4028..2caccaa0fb6 100644 --- a/llvm/tools/llvm-dwarfdump/fuzzer/llvm-dwarfdump-fuzzer.cpp +++ b/llvm/tools/llvm-dwarfdump/fuzzer/llvm-dwarfdump-fuzzer.cpp @@ -8,7 +8,7 @@ //===----------------------------------------------------------------------===// /// /// \file -/// \brief This file implements a function that runs llvm-dwarfdump +/// This file implements a function that runs llvm-dwarfdump /// on a single input. This function is then linked into the Fuzzer library. /// //===----------------------------------------------------------------------===// diff --git a/llvm/tools/llvm-lto/llvm-lto.cpp b/llvm/tools/llvm-lto/llvm-lto.cpp index f58da89d28a..97f022d18b1 100644 --- a/llvm/tools/llvm-lto/llvm-lto.cpp +++ b/llvm/tools/llvm-lto/llvm-lto.cpp @@ -350,7 +350,7 @@ void printIndexStats() { } } -/// \brief List symbols in each IR file. +/// List symbols in each IR file. /// /// The main point here is to provide lit-testable coverage for the LTOModule /// functionality that's exposed by the C API to list symbols. Moreover, this diff --git a/llvm/tools/llvm-mca/Backend.h b/llvm/tools/llvm-mca/Backend.h index c21da1f23af..d294b610731 100644 --- a/llvm/tools/llvm-mca/Backend.h +++ b/llvm/tools/llvm-mca/Backend.h @@ -26,7 +26,7 @@ class HWEventListener; class HWInstructionEvent; class HWStallEvent; -/// \brief An out of order backend for a specific subtarget. +/// An out of order backend for a specific subtarget. /// /// It emulates an out-of-order execution of instructions. Instructions are /// fetched from a MCInst sequence managed by an object of class SourceMgr. diff --git a/llvm/tools/llvm-mca/BackendPrinter.h b/llvm/tools/llvm-mca/BackendPrinter.h index d159a950baa..e367554d06a 100644 --- a/llvm/tools/llvm-mca/BackendPrinter.h +++ b/llvm/tools/llvm-mca/BackendPrinter.h @@ -26,7 +26,7 @@ namespace mca { -/// \brief A printer class that knows how to collects statistics on the +/// A printer class that knows how to collects statistics on the /// code analyzed by the llvm-mca tool. /// /// This class knows how to print out the analysis information collected diff --git a/llvm/tools/llvm-mca/CodeRegion.h b/llvm/tools/llvm-mca/CodeRegion.h index 6dc3f01332f..7f0025e4884 100644 --- a/llvm/tools/llvm-mca/CodeRegion.h +++ b/llvm/tools/llvm-mca/CodeRegion.h @@ -42,7 +42,7 @@ namespace mca { -/// \brief A region of assembly code. +/// A region of assembly code. /// /// It identifies a sequence of machine instructions. class CodeRegion { diff --git a/llvm/tools/llvm-mca/Dispatch.h b/llvm/tools/llvm-mca/Dispatch.h index c08515d40a3..146cfc0edea 100644 --- a/llvm/tools/llvm-mca/Dispatch.h +++ b/llvm/tools/llvm-mca/Dispatch.h @@ -28,7 +28,7 @@ class DispatchUnit; class Scheduler; class Backend; -/// \brief Manages hardware register files, and tracks data dependencies +/// Manages hardware register files, and tracks data dependencies /// between registers. class RegisterFile { const llvm::MCRegisterInfo &MRI; @@ -155,7 +155,7 @@ public: #endif }; -/// \brief tracks which instructions are in-flight (i.e. dispatched but not +/// tracks which instructions are in-flight (i.e. dispatched but not /// retired) in the OoO backend. /// /// This class checks on every cycle if/which instructions can be retired. @@ -217,7 +217,7 @@ public: #endif }; -// \brief Implements the hardware dispatch logic. +// Implements the hardware dispatch logic. // // This class is responsible for the dispatch stage, in which instructions are // dispatched in groups to the Scheduler. An instruction can be dispatched if diff --git a/llvm/tools/llvm-mca/InstrBuilder.h b/llvm/tools/llvm-mca/InstrBuilder.h index a3b7001b86b..30af1bf33ab 100644 --- a/llvm/tools/llvm-mca/InstrBuilder.h +++ b/llvm/tools/llvm-mca/InstrBuilder.h @@ -24,7 +24,7 @@ namespace mca { class DispatchUnit; -/// \brief A builder class that knows how to construct Instruction objects. +/// A builder class that knows how to construct Instruction objects. /// /// Every llvm-mca Instruction is described by an object of class InstrDesc. /// An InstrDesc describes which registers are read/written by the instruction, diff --git a/llvm/tools/llvm-mca/Instruction.h b/llvm/tools/llvm-mca/Instruction.h index 59134bc33de..21fec94eeb5 100644 --- a/llvm/tools/llvm-mca/Instruction.h +++ b/llvm/tools/llvm-mca/Instruction.h @@ -30,7 +30,7 @@ class ReadState; constexpr int UNKNOWN_CYCLES = -512; -/// \brief A register write descriptor. +/// A register write descriptor. struct WriteDescriptor { // Operand index. -1 if this is an implicit write. int OpIndex; @@ -59,7 +59,7 @@ struct WriteDescriptor { bool IsOptionalDef; }; -/// \brief A register read descriptor. +/// A register read descriptor. struct ReadDescriptor { // A MCOperand index. This is used by the Dispatch logic to identify register // reads. This field defaults to -1 if this is an implicit read. @@ -79,7 +79,7 @@ struct ReadDescriptor { bool HasReadAdvanceEntries; }; -/// \brief Tracks uses of a register definition (e.g. register write). +/// Tracks uses of a register definition (e.g. register write). /// /// Each implicit/explicit register write is associated with an instance of /// this class. A WriteState object tracks the dependent users of a @@ -128,7 +128,7 @@ public: #endif }; -/// \brief Tracks register operand latency in cycles. +/// Tracks register operand latency in cycles. /// /// A read may be dependent on more than one write. This occurs when some /// writes only partially update the register associated to this read. @@ -160,7 +160,7 @@ public: void setDependentWrites(unsigned Writes) { DependentWrites = Writes; } }; -/// \brief A sequence of cycles. +/// A sequence of cycles. /// /// This class can be used as a building block to construct ranges of cycles. class CycleSegment { @@ -205,7 +205,7 @@ public: void setReserved() { Reserved = true; } }; -/// \brief Helper used by class InstrDesc to describe how hardware resources +/// Helper used by class InstrDesc to describe how hardware resources /// are used. /// /// This class describes how many resource units of a specific resource kind @@ -220,7 +220,7 @@ struct ResourceUsage { void setReserved() { CS.setReserved(); } }; -/// \brief An instruction descriptor +/// An instruction descriptor struct InstrDesc { std::vector<WriteDescriptor> Writes; // Implicit writes are at the end. std::vector<ReadDescriptor> Reads; // Implicit reads are at the end. diff --git a/llvm/tools/llvm-mca/InstructionInfoView.h b/llvm/tools/llvm-mca/InstructionInfoView.h index 85d064430b3..0770ae3d2b5 100644 --- a/llvm/tools/llvm-mca/InstructionInfoView.h +++ b/llvm/tools/llvm-mca/InstructionInfoView.h @@ -46,7 +46,7 @@ namespace mca { -/// \brief A view that prints out generic instruction information. +/// A view that prints out generic instruction information. class InstructionInfoView : public View { const llvm::MCSubtargetInfo &STI; const llvm::MCInstrInfo &MCII; diff --git a/llvm/tools/llvm-mca/LSUnit.h b/llvm/tools/llvm-mca/LSUnit.h index 3cfde5a55b7..d291a09eb0e 100644 --- a/llvm/tools/llvm-mca/LSUnit.h +++ b/llvm/tools/llvm-mca/LSUnit.h @@ -26,7 +26,7 @@ namespace mca { struct InstrDesc; -/// \brief A Load/Store Unit implementing a load and store queues. +/// A Load/Store Unit implementing a load and store queues. /// /// This class implements a load queue and a store queue to emulate the /// out-of-order execution of memory operations. diff --git a/llvm/tools/llvm-mca/Scheduler.h b/llvm/tools/llvm-mca/Scheduler.h index f3b9a362ad1..25bc87e3eba 100644 --- a/llvm/tools/llvm-mca/Scheduler.h +++ b/llvm/tools/llvm-mca/Scheduler.h @@ -46,7 +46,7 @@ enum ResourceStateEvent { RS_RESERVED }; -/// \brief A descriptor for processor resources. +/// A descriptor for processor resources. /// /// Each object of class ResourceState is associated to a specific processor /// resource. There is an instance of this class for every processor resource @@ -250,7 +250,7 @@ public: #endif }; -/// \brief A resource unit identifier. +/// A resource unit identifier. /// /// This is used to identify a specific processor resource unit using a pair /// of indices where the 'first' index is a processor resource mask, and the diff --git a/llvm/tools/llvm-mca/SummaryView.h b/llvm/tools/llvm-mca/SummaryView.h index 9c543519469..0484057fb10 100644 --- a/llvm/tools/llvm-mca/SummaryView.h +++ b/llvm/tools/llvm-mca/SummaryView.h @@ -35,7 +35,7 @@ namespace mca { -/// \brief A view that collects and prints a few performance numbers. +/// A view that collects and prints a few performance numbers. class SummaryView : public View { const SourceMgr &Source; const unsigned DispatchWidth; diff --git a/llvm/tools/llvm-mca/TimelineView.h b/llvm/tools/llvm-mca/TimelineView.h index 6ec373dd38b..09dc99055b3 100644 --- a/llvm/tools/llvm-mca/TimelineView.h +++ b/llvm/tools/llvm-mca/TimelineView.h @@ -109,7 +109,7 @@ namespace mca { -/// \brief This class listens to instruction state transition events +/// This class listens to instruction state transition events /// in order to construct a timeline information. /// /// For every instruction executed by the Backend, this class constructs diff --git a/llvm/tools/llvm-objdump/COFFDump.cpp b/llvm/tools/llvm-objdump/COFFDump.cpp index d84f768bf81..7ca5d04593f 100644 --- a/llvm/tools/llvm-objdump/COFFDump.cpp +++ b/llvm/tools/llvm-objdump/COFFDump.cpp @@ -8,7 +8,7 @@ //===----------------------------------------------------------------------===// /// /// \file -/// \brief This file implements the COFF-specific dumper for llvm-objdump. +/// This file implements the COFF-specific dumper for llvm-objdump. /// It outputs the Win64 EH data structures as plain text. /// The encoding of the unwind codes is described in MSDN: /// http://msdn.microsoft.com/en-us/library/ck9asaa9.aspx diff --git a/llvm/tools/llvm-objdump/ELFDump.cpp b/llvm/tools/llvm-objdump/ELFDump.cpp index 7f5fe5a9d3b..9475ab35f11 100644 --- a/llvm/tools/llvm-objdump/ELFDump.cpp +++ b/llvm/tools/llvm-objdump/ELFDump.cpp @@ -8,7 +8,7 @@ //===----------------------------------------------------------------------===// /// /// \file -/// \brief This file implements the ELF-specific dumper for llvm-objdump. +/// This file implements the ELF-specific dumper for llvm-objdump. /// //===----------------------------------------------------------------------===// diff --git a/llvm/tools/llvm-objdump/MachODump.cpp b/llvm/tools/llvm-objdump/MachODump.cpp index fe2897bd3e9..7e4f996d41a 100644 --- a/llvm/tools/llvm-objdump/MachODump.cpp +++ b/llvm/tools/llvm-objdump/MachODump.cpp @@ -6753,7 +6753,7 @@ static const char *SymbolizerSymbolLookUp(void *DisInfo, return SymbolName; } -/// \brief Emits the comments that are stored in the CommentStream. +/// Emits the comments that are stored in the CommentStream. /// Each comment in the CommentStream must end with a newline. static void emitComments(raw_svector_ostream &CommentStream, SmallString<128> &CommentsToEmit, diff --git a/llvm/tools/llvm-objdump/WasmDump.cpp b/llvm/tools/llvm-objdump/WasmDump.cpp index 0d8ffba6ba4..045002cd4b3 100644 --- a/llvm/tools/llvm-objdump/WasmDump.cpp +++ b/llvm/tools/llvm-objdump/WasmDump.cpp @@ -8,7 +8,7 @@ //===----------------------------------------------------------------------===// /// /// \file -/// \brief This file implements the wasm-specific dumper for llvm-objdump. +/// This file implements the wasm-specific dumper for llvm-objdump. /// //===----------------------------------------------------------------------===// diff --git a/llvm/tools/llvm-opt-report/OptReport.cpp b/llvm/tools/llvm-opt-report/OptReport.cpp index c90fdb0ad01..aa7966132c2 100644 --- a/llvm/tools/llvm-opt-report/OptReport.cpp +++ b/llvm/tools/llvm-opt-report/OptReport.cpp @@ -8,7 +8,7 @@ //===----------------------------------------------------------------------===// /// /// \file -/// \brief This file implements a tool that can parse the YAML optimization +/// This file implements a tool that can parse the YAML optimization /// records and generate an optimization summary annotated source listing /// report. /// diff --git a/llvm/tools/llvm-readobj/COFFDumper.cpp b/llvm/tools/llvm-readobj/COFFDumper.cpp index 2567d6dc159..0ed4ccd09f6 100644 --- a/llvm/tools/llvm-readobj/COFFDumper.cpp +++ b/llvm/tools/llvm-readobj/COFFDumper.cpp @@ -8,7 +8,7 @@ //===----------------------------------------------------------------------===// /// /// \file -/// \brief This file implements the COFF-specific dumper for llvm-readobj. +/// This file implements the COFF-specific dumper for llvm-readobj. /// //===----------------------------------------------------------------------===// diff --git a/llvm/tools/llvm-readobj/COFFImportDumper.cpp b/llvm/tools/llvm-readobj/COFFImportDumper.cpp index fa6118ee4d6..18010c34f0f 100644 --- a/llvm/tools/llvm-readobj/COFFImportDumper.cpp +++ b/llvm/tools/llvm-readobj/COFFImportDumper.cpp @@ -8,7 +8,7 @@ //===----------------------------------------------------------------------===// /// /// \file -/// \brief This file implements the COFF import library dumper for llvm-readobj. +/// This file implements the COFF import library dumper for llvm-readobj. /// //===----------------------------------------------------------------------===// diff --git a/llvm/tools/llvm-readobj/ELFDumper.cpp b/llvm/tools/llvm-readobj/ELFDumper.cpp index aa4ce25daed..32ab126d8d5 100644 --- a/llvm/tools/llvm-readobj/ELFDumper.cpp +++ b/llvm/tools/llvm-readobj/ELFDumper.cpp @@ -8,7 +8,7 @@ //===----------------------------------------------------------------------===// /// /// \file -/// \brief This file implements the ELF-specific dumper for llvm-readobj. +/// This file implements the ELF-specific dumper for llvm-readobj. /// //===----------------------------------------------------------------------===// @@ -115,11 +115,11 @@ struct DynRegionInfo { DynRegionInfo(const void *A, uint64_t S, uint64_t ES) : Addr(A), Size(S), EntSize(ES) {} - /// \brief Address in current address space. + /// Address in current address space. const void *Addr = nullptr; - /// \brief Size in bytes of the region. + /// Size in bytes of the region. uint64_t Size = 0; - /// \brief Size of each entity in the region. + /// Size of each entity in the region. uint64_t EntSize = 0; template <typename Type> ArrayRef<Type> getAsArrayRef() const { diff --git a/llvm/tools/llvm-readobj/ObjDumper.cpp b/llvm/tools/llvm-readobj/ObjDumper.cpp index 2a0a90e5cfd..95a6d0325e2 100644 --- a/llvm/tools/llvm-readobj/ObjDumper.cpp +++ b/llvm/tools/llvm-readobj/ObjDumper.cpp @@ -8,7 +8,7 @@ //===----------------------------------------------------------------------===// /// /// \file -/// \brief This file implements ObjDumper. +/// This file implements ObjDumper. /// //===----------------------------------------------------------------------===// diff --git a/llvm/tools/opt/BreakpointPrinter.cpp b/llvm/tools/opt/BreakpointPrinter.cpp index e5614ed061e..d3f54c034f5 100644 --- a/llvm/tools/opt/BreakpointPrinter.cpp +++ b/llvm/tools/opt/BreakpointPrinter.cpp @@ -8,7 +8,7 @@ //===----------------------------------------------------------------------===// /// /// \file -/// \brief Breakpoint location printer. +/// Breakpoint location printer. /// //===----------------------------------------------------------------------===// #include "BreakpointPrinter.h" diff --git a/llvm/tools/opt/BreakpointPrinter.h b/llvm/tools/opt/BreakpointPrinter.h index 81c88e19199..57670e5ee8d 100644 --- a/llvm/tools/opt/BreakpointPrinter.h +++ b/llvm/tools/opt/BreakpointPrinter.h @@ -8,7 +8,7 @@ //===----------------------------------------------------------------------===// /// /// \file -/// \brief Breakpoint location printer. +/// Breakpoint location printer. /// //===----------------------------------------------------------------------===// #ifndef LLVM_TOOLS_OPT_BREAKPOINTPRINTER_H diff --git a/llvm/tools/opt/NewPMDriver.h b/llvm/tools/opt/NewPMDriver.h index 2f09e5a8afa..7d74a5777d1 100644 --- a/llvm/tools/opt/NewPMDriver.h +++ b/llvm/tools/opt/NewPMDriver.h @@ -42,7 +42,7 @@ enum VerifierKind { }; } -/// \brief Driver function to run the new pass manager over a module. +/// Driver function to run the new pass manager over a module. /// /// This function only exists factored away from opt.cpp in order to prevent /// inclusion of the new pass manager headers and the old headers into the same diff --git a/llvm/tools/opt/PassPrinters.cpp b/llvm/tools/opt/PassPrinters.cpp index f52b5208094..310d491c06a 100644 --- a/llvm/tools/opt/PassPrinters.cpp +++ b/llvm/tools/opt/PassPrinters.cpp @@ -8,7 +8,7 @@ //===----------------------------------------------------------------------===// /// /// \file -/// \brief Utilities to print analysis info for various kinds of passes. +/// Utilities to print analysis info for various kinds of passes. /// //===----------------------------------------------------------------------===// diff --git a/llvm/tools/opt/PassPrinters.h b/llvm/tools/opt/PassPrinters.h index 6eba94795eb..1b0cea00835 100644 --- a/llvm/tools/opt/PassPrinters.h +++ b/llvm/tools/opt/PassPrinters.h @@ -8,7 +8,7 @@ //===----------------------------------------------------------------------===// /// /// \file -/// \brief Utilities to print analysis info for various kinds of passes. +/// Utilities to print analysis info for various kinds of passes. /// //===----------------------------------------------------------------------===// diff --git a/llvm/tools/verify-uselistorder/verify-uselistorder.cpp b/llvm/tools/verify-uselistorder/verify-uselistorder.cpp index ccc62cd158a..d0d6f01551f 100644 --- a/llvm/tools/verify-uselistorder/verify-uselistorder.cpp +++ b/llvm/tools/verify-uselistorder/verify-uselistorder.cpp @@ -83,7 +83,7 @@ struct ValueMapping { DenseMap<const Value *, unsigned> IDs; std::vector<const Value *> Values; - /// \brief Construct a value mapping for module. + /// Construct a value mapping for module. /// /// Creates mapping from every value in \c M to an ID. This mapping includes /// un-referencable values. @@ -96,7 +96,7 @@ struct ValueMapping { /// mapping, but others -- which wouldn't be serialized -- are not. ValueMapping(const Module &M); - /// \brief Map a value. + /// Map a value. /// /// Maps a value. If it's a constant, maps all of its operands first. void map(const Value *V); diff --git a/llvm/tools/yaml2obj/yaml2coff.cpp b/llvm/tools/yaml2obj/yaml2coff.cpp index 88af85dcb0d..befa01b369c 100644 --- a/llvm/tools/yaml2obj/yaml2coff.cpp +++ b/llvm/tools/yaml2obj/yaml2coff.cpp @@ -8,7 +8,7 @@ //===----------------------------------------------------------------------===// /// /// \file -/// \brief The COFF component of yaml2obj. +/// The COFF component of yaml2obj. /// //===----------------------------------------------------------------------===// diff --git a/llvm/tools/yaml2obj/yaml2elf.cpp b/llvm/tools/yaml2obj/yaml2elf.cpp index fb23d1f7cf7..59da9376a59 100644 --- a/llvm/tools/yaml2obj/yaml2elf.cpp +++ b/llvm/tools/yaml2obj/yaml2elf.cpp @@ -8,7 +8,7 @@ //===----------------------------------------------------------------------===// /// /// \file -/// \brief The ELF component of yaml2obj. +/// The ELF component of yaml2obj. /// //===----------------------------------------------------------------------===// @@ -103,7 +103,7 @@ static void zero(T &Obj) { } namespace { -/// \brief "Single point of truth" for the ELF file construction. +/// "Single point of truth" for the ELF file construction. /// TODO: This class still has a ways to go before it is truly a "single /// point of truth". template <class ELFT> @@ -117,13 +117,13 @@ class ELFState { enum class SymtabType { Static, Dynamic }; - /// \brief The future ".strtab" section. + /// The future ".strtab" section. StringTableBuilder DotStrtab{StringTableBuilder::ELF}; - /// \brief The future ".shstrtab" section. + /// The future ".shstrtab" section. StringTableBuilder DotShStrtab{StringTableBuilder::ELF}; - /// \brief The future ".dynstr" section. + /// The future ".dynstr" section. StringTableBuilder DotDynstr{StringTableBuilder::ELF}; NameToIdxMap SN2I; diff --git a/llvm/tools/yaml2obj/yaml2macho.cpp b/llvm/tools/yaml2obj/yaml2macho.cpp index 1bb50a9aab5..23fe946f1da 100644 --- a/llvm/tools/yaml2obj/yaml2macho.cpp +++ b/llvm/tools/yaml2obj/yaml2macho.cpp @@ -8,7 +8,7 @@ //===----------------------------------------------------------------------===// /// /// \file -/// \brief The Mach component of yaml2obj. +/// The Mach component of yaml2obj. /// //===----------------------------------------------------------------------===// diff --git a/llvm/tools/yaml2obj/yaml2obj.h b/llvm/tools/yaml2obj/yaml2obj.h index cb8f1190491..fc784067a9f 100644 --- a/llvm/tools/yaml2obj/yaml2obj.h +++ b/llvm/tools/yaml2obj/yaml2obj.h @@ -7,7 +7,7 @@ // //===----------------------------------------------------------------------===// /// \file -/// \brief Common declarations for yaml2obj +/// Common declarations for yaml2obj //===----------------------------------------------------------------------===// #ifndef LLVM_TOOLS_YAML2OBJ_YAML2OBJ_H #define LLVM_TOOLS_YAML2OBJ_YAML2OBJ_H diff --git a/llvm/tools/yaml2obj/yaml2wasm.cpp b/llvm/tools/yaml2obj/yaml2wasm.cpp index 9b8770ff1f6..a7ec25e31c7 100644 --- a/llvm/tools/yaml2obj/yaml2wasm.cpp +++ b/llvm/tools/yaml2obj/yaml2wasm.cpp @@ -8,7 +8,7 @@ //===----------------------------------------------------------------------===// /// /// \file -/// \brief The Wasm component of yaml2obj. +/// The Wasm component of yaml2obj. /// //===----------------------------------------------------------------------===// // |
