diff --git a/clang-tools-extra/clang-apply-replacements/include/clang-apply-replacements/Tooling/ApplyReplacements.h b/clang-tools-extra/clang-apply-replacements/include/clang-apply-replacements/Tooling/ApplyReplacements.h index 979b112d999e..bab19270e85c 100644 --- a/clang-tools-extra/clang-apply-replacements/include/clang-apply-replacements/Tooling/ApplyReplacements.h +++ b/clang-tools-extra/clang-apply-replacements/include/clang-apply-replacements/Tooling/ApplyReplacements.h @@ -84,7 +84,8 @@ collectReplacementsFromDirectory(const llvm::StringRef Directory, /// file they target. /// \param[in] SM SourceManager required for conflict reporting. /// -/// \returns \li true If all changes were applied successfully. +/// \returns \parblock +/// \li true If all changes were applied successfully. /// \li false If there were conflicts. bool mergeAndDeduplicate(const TUReplacements &TUs, FileToReplacementsMap &GroupedReplacements, @@ -97,7 +98,8 @@ bool mergeAndDeduplicate(const TUReplacements &TUs, /// \param[out] Rewrites The results of applying replacements will be applied /// to this Rewriter. /// -/// \returns \li true If all changes were applied successfully. +/// \returns \parblock +/// \li true If all changes were applied successfully. /// \li false If a replacement failed to apply. bool applyReplacements(const FileToReplacementsMap &GroupedReplacements, clang::Rewriter &Rewrites); @@ -125,7 +127,8 @@ bool writeFiles(const clang::Rewriter &Rewrites); /// \param[in] Files Replacement files to delete. /// \param[in] Diagnostics DiagnosticsEngine used for error output. /// -/// \returns \li true If all files have been deleted successfully. +/// \returns \parblock +/// \li true If all files have been deleted successfully. /// \li false If at least one or more failures occur when deleting /// files. bool deleteReplacementFiles(const TUReplacementFiles &Files, diff --git a/clang-tools-extra/clang-apply-replacements/lib/Tooling/ApplyReplacements.cpp b/clang-tools-extra/clang-apply-replacements/lib/Tooling/ApplyReplacements.cpp index def5f1aa9dbe..548e3c60fb42 100644 --- a/clang-tools-extra/clang-apply-replacements/lib/Tooling/ApplyReplacements.cpp +++ b/clang-tools-extra/clang-apply-replacements/lib/Tooling/ApplyReplacements.cpp @@ -131,7 +131,8 @@ static void reportConflict( /// to be deduplicated and checked for conflicts. /// \param[in] SM SourceManager required for conflict reporting. /// -/// \returns \li true if conflicts were detected +/// \returns \parblock +/// \li true if conflicts were detected /// \li false if no conflicts were detected static bool deduplicateAndDetectConflicts(FileToReplacementsMap &Replacements, SourceManager &SM) { diff --git a/clang-tools-extra/clang-apply-replacements/tool/ClangApplyReplacementsMain.cpp b/clang-tools-extra/clang-apply-replacements/tool/ClangApplyReplacementsMain.cpp index ed1b2da77a39..fdf6eb881fab 100644 --- a/clang-tools-extra/clang-apply-replacements/tool/ClangApplyReplacementsMain.cpp +++ b/clang-tools-extra/clang-apply-replacements/tool/ClangApplyReplacementsMain.cpp @@ -100,7 +100,8 @@ static void printVersion() { /// \param[out] Result Contents of the file after applying replacements if /// replacements were provided. /// -/// \returns \li true if all replacements were applied successfully. +/// \returns \parblock +/// \li true if all replacements were applied successfully. /// \li false if at least one replacement failed to apply. static bool getRewrittenData(const std::vector &Replacements, @@ -134,7 +135,8 @@ getRewrittenData(const std::vector &Replacements, /// replacements were provided. /// \param[in] Diagnostics For diagnostic output. /// -/// \returns \li true if all replacements applied successfully. +/// \returns \parblock +/// \li true if all replacements applied successfully. /// \li false if at least one replacement failed to apply. static bool applyReplacements(const std::vector &Replacements, @@ -160,7 +162,8 @@ applyReplacements(const std::vector &Replacements, /// \param[in] FormatStyle Style to apply. /// \param[in] Diagnostics For diagnostic output. /// -/// \returns \li true if reformatting replacements were all successfully +/// \returns \parblock +/// \li true if reformatting replacements were all successfully /// applied. /// \li false if at least one reformatting replacement failed to apply. static bool diff --git a/clang-tools-extra/clang-modernize/Core/IncludeDirectives.h b/clang-tools-extra/clang-modernize/Core/IncludeDirectives.h index b2dcbb46f79a..577eccfe23b3 100644 --- a/clang-tools-extra/clang-modernize/Core/IncludeDirectives.h +++ b/clang-tools-extra/clang-modernize/Core/IncludeDirectives.h @@ -41,7 +41,7 @@ public: /// \param File A file accessible by a SourceManager /// \param Include The include file as it should be written in the code. /// - /// \returns + /// \returns \parblock /// \li A null Replacement (check using \c Replacement::isApplicable()), if /// the \c Include is already visible from \c File. /// \li Otherwise, a non-null Replacement that, when applied, inserts an diff --git a/clang-tools-extra/clang-modernize/Core/ReplacementHandling.h b/clang-tools-extra/clang-modernize/Core/ReplacementHandling.h index 54b9655eefd6..c4e79d49c548 100644 --- a/clang-tools-extra/clang-modernize/Core/ReplacementHandling.h +++ b/clang-tools-extra/clang-modernize/Core/ReplacementHandling.h @@ -31,7 +31,8 @@ public: /// /// \param[in] Argv0 argv[0] as passed to main(). /// - /// \returns \li true if clang-apply-replacements was found. + /// \returns \parblock + /// \li true if clang-apply-replacements was found. /// \li false otherwise. bool findClangApplyReplacements(const char *Argv0); @@ -65,7 +66,8 @@ public: /// /// \param[in] Replacements Container of replacements to serialize. /// - /// \returns \li true if all replacements were serialized successfully to + /// \returns \parblock + /// \li true if all replacements were serialized successfully to /// disk. /// \li false otherwise. bool serializeReplacements(const TUReplacementsMap &Replacements); @@ -76,7 +78,8 @@ public: /// \pre Destination directory must have been previously set by calling /// setDestiantionDir() or useTempDestinationDir(). /// - /// \returns \li true if clang-apply-replacements was successfully launched + /// \returns \parblock + /// \li true if clang-apply-replacements was successfully launched /// and successfully completed. /// \li false otherwise. bool applyReplacements(); @@ -97,7 +100,8 @@ public: /// \param[out] Error If an error occurs a description of that error is /// placed in this string. /// - /// \returns \li true on success + /// \returns \parblock + /// \li true on success /// \li false if a unique file name could not be created. static bool generateReplacementsFileName(llvm::StringRef DestinationDir, llvm::StringRef MainSourceFile, diff --git a/clang-tools-extra/clang-modernize/Core/Transform.h b/clang-tools-extra/clang-modernize/Core/Transform.h index 7c3be9d09f2c..511a2bcd39ed 100644 --- a/clang-tools-extra/clang-modernize/Core/Transform.h +++ b/clang-tools-extra/clang-modernize/Core/Transform.h @@ -95,7 +95,8 @@ public: /// \p SourcePaths. /// \param[in] SourcePaths list of sources to transform. /// - /// \returns \li 0 if successful + /// \returns \parblock + /// \li 0 if successful /// \li 1 otherwise virtual int apply(const clang::tooling::CompilationDatabase &Database, const std::vector &SourcePaths) = 0; @@ -171,7 +172,8 @@ public: /// \brief Add a Replacement to the list for the current translation unit. /// - /// \returns \li true on success + /// \returns \parblock + /// \li true on success /// \li false if there is no current translation unit bool addReplacementForCurrentTU(const clang::tooling::Replacement &R);