diff options
author | NAKAMURA Takumi <geek4civic@gmail.com> | 2015-09-19 02:21:28 +0000 |
---|---|---|
committer | NAKAMURA Takumi <geek4civic@gmail.com> | 2015-09-19 02:21:28 +0000 |
commit | e677e2f5451e6f0ff329a000d3ede8e4acfa5a5f (patch) | |
tree | 3c10741e5cbb86437086b838d17d5841a5994c11 /clang-tools-extra/clang-apply-replacements | |
parent | 664798c034fb0ceb6ac1e5aba8138cce8dd701db (diff) | |
download | bcm5719-llvm-e677e2f5451e6f0ff329a000d3ede8e4acfa5a5f.tar.gz bcm5719-llvm-e677e2f5451e6f0ff329a000d3ede8e4acfa5a5f.zip |
clang-tools-extra: Appease PR24881. [-Wdocumentation]
\returns doesn't accept \li, but \parblock \li.
llvm-svn: 248080
Diffstat (limited to 'clang-tools-extra/clang-apply-replacements')
3 files changed, 14 insertions, 7 deletions
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 979b112d999..bab19270e85 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 def5f1aa9db..548e3c60fb4 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 ed1b2da77a3..fdf6eb881fa 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<tooling::Replacement> &Replacements, @@ -134,7 +135,8 @@ getRewrittenData(const std::vector<tooling::Replacement> &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<tooling::Replacement> &Replacements, @@ -160,7 +162,8 @@ applyReplacements(const std::vector<tooling::Replacement> &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 |