<div dir="ltr">Thanks!<div><br></div><div>-- Sean Silva</div></div><div class="gmail_extra"><br><div class="gmail_quote">On Fri, Sep 18, 2015 at 7:21 PM, NAKAMURA Takumi via cfe-commits <span dir="ltr"><<a href="mailto:cfe-commits@lists.llvm.org" target="_blank">cfe-commits@lists.llvm.org</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">Author: chapuni<br>
Date: Fri Sep 18 21:21:28 2015<br>
New Revision: 248080<br>
<br>
URL: <a href="http://llvm.org/viewvc/llvm-project?rev=248080&view=rev" rel="noreferrer" target="_blank">http://llvm.org/viewvc/llvm-project?rev=248080&view=rev</a><br>
Log:<br>
clang-tools-extra: Appease PR24881. [-Wdocumentation]<br>
<br>
\returns doesn't accept \li, but \parblock \li.<br>
<br>
Modified:<br>
clang-tools-extra/trunk/clang-apply-replacements/include/clang-apply-replacements/Tooling/ApplyReplacements.h<br>
clang-tools-extra/trunk/clang-apply-replacements/lib/Tooling/ApplyReplacements.cpp<br>
clang-tools-extra/trunk/clang-apply-replacements/tool/ClangApplyReplacementsMain.cpp<br>
clang-tools-extra/trunk/clang-modernize/Core/IncludeDirectives.h<br>
clang-tools-extra/trunk/clang-modernize/Core/ReplacementHandling.h<br>
clang-tools-extra/trunk/clang-modernize/Core/Transform.h<br>
<br>
Modified: clang-tools-extra/trunk/clang-apply-replacements/include/clang-apply-replacements/Tooling/ApplyReplacements.h<br>
URL: <a href="http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/clang-apply-replacements/include/clang-apply-replacements/Tooling/ApplyReplacements.h?rev=248080&r1=248079&r2=248080&view=diff" rel="noreferrer" target="_blank">http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/clang-apply-replacements/include/clang-apply-replacements/Tooling/ApplyReplacements.h?rev=248080&r1=248079&r2=248080&view=diff</a><br>
==============================================================================<br>
--- clang-tools-extra/trunk/clang-apply-replacements/include/clang-apply-replacements/Tooling/ApplyReplacements.h (original)<br>
+++ clang-tools-extra/trunk/clang-apply-replacements/include/clang-apply-replacements/Tooling/ApplyReplacements.h Fri Sep 18 21:21:28 2015<br>
@@ -84,7 +84,8 @@ collectReplacementsFromDirectory(const l<br>
/// file they target.<br>
/// \param[in] SM SourceManager required for conflict reporting.<br>
///<br>
-/// \returns \li true If all changes were applied successfully.<br>
+/// \returns \parblock<br>
+/// \li true If all changes were applied successfully.<br>
/// \li false If there were conflicts.<br>
bool mergeAndDeduplicate(const TUReplacements &TUs,<br>
FileToReplacementsMap &GroupedReplacements,<br>
@@ -97,7 +98,8 @@ bool mergeAndDeduplicate(const TUReplace<br>
/// \param[out] Rewrites The results of applying replacements will be applied<br>
/// to this Rewriter.<br>
///<br>
-/// \returns \li true If all changes were applied successfully.<br>
+/// \returns \parblock<br>
+/// \li true If all changes were applied successfully.<br>
/// \li false If a replacement failed to apply.<br>
bool applyReplacements(const FileToReplacementsMap &GroupedReplacements,<br>
clang::Rewriter &Rewrites);<br>
@@ -125,7 +127,8 @@ bool writeFiles(const clang::Rewriter &R<br>
/// \param[in] Files Replacement files to delete.<br>
/// \param[in] Diagnostics DiagnosticsEngine used for error output.<br>
///<br>
-/// \returns \li true If all files have been deleted successfully.<br>
+/// \returns \parblock<br>
+/// \li true If all files have been deleted successfully.<br>
/// \li false If at least one or more failures occur when deleting<br>
/// files.<br>
bool deleteReplacementFiles(const TUReplacementFiles &Files,<br>
<br>
Modified: clang-tools-extra/trunk/clang-apply-replacements/lib/Tooling/ApplyReplacements.cpp<br>
URL: <a href="http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/clang-apply-replacements/lib/Tooling/ApplyReplacements.cpp?rev=248080&r1=248079&r2=248080&view=diff" rel="noreferrer" target="_blank">http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/clang-apply-replacements/lib/Tooling/ApplyReplacements.cpp?rev=248080&r1=248079&r2=248080&view=diff</a><br>
==============================================================================<br>
--- clang-tools-extra/trunk/clang-apply-replacements/lib/Tooling/ApplyReplacements.cpp (original)<br>
+++ clang-tools-extra/trunk/clang-apply-replacements/lib/Tooling/ApplyReplacements.cpp Fri Sep 18 21:21:28 2015<br>
@@ -131,7 +131,8 @@ static void reportConflict(<br>
/// to be deduplicated and checked for conflicts.<br>
/// \param[in] SM SourceManager required for conflict reporting.<br>
///<br>
-/// \returns \li true if conflicts were detected<br>
+/// \returns \parblock<br>
+/// \li true if conflicts were detected<br>
/// \li false if no conflicts were detected<br>
static bool deduplicateAndDetectConflicts(FileToReplacementsMap &Replacements,<br>
SourceManager &SM) {<br>
<br>
Modified: clang-tools-extra/trunk/clang-apply-replacements/tool/ClangApplyReplacementsMain.cpp<br>
URL: <a href="http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/clang-apply-replacements/tool/ClangApplyReplacementsMain.cpp?rev=248080&r1=248079&r2=248080&view=diff" rel="noreferrer" target="_blank">http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/clang-apply-replacements/tool/ClangApplyReplacementsMain.cpp?rev=248080&r1=248079&r2=248080&view=diff</a><br>
==============================================================================<br>
--- clang-tools-extra/trunk/clang-apply-replacements/tool/ClangApplyReplacementsMain.cpp (original)<br>
+++ clang-tools-extra/trunk/clang-apply-replacements/tool/ClangApplyReplacementsMain.cpp Fri Sep 18 21:21:28 2015<br>
@@ -100,7 +100,8 @@ static void printVersion() {<br>
/// \param[out] Result Contents of the file after applying replacements if<br>
/// replacements were provided.<br>
///<br>
-/// \returns \li true if all replacements were applied successfully.<br>
+/// \returns \parblock<br>
+/// \li true if all replacements were applied successfully.<br>
/// \li false if at least one replacement failed to apply.<br>
static bool<br>
getRewrittenData(const std::vector<tooling::Replacement> &Replacements,<br>
@@ -134,7 +135,8 @@ getRewrittenData(const std::vector<tooli<br>
/// replacements were provided.<br>
/// \param[in] Diagnostics For diagnostic output.<br>
///<br>
-/// \returns \li true if all replacements applied successfully.<br>
+/// \returns \parblock<br>
+/// \li true if all replacements applied successfully.<br>
/// \li false if at least one replacement failed to apply.<br>
static bool<br>
applyReplacements(const std::vector<tooling::Replacement> &Replacements,<br>
@@ -160,7 +162,8 @@ applyReplacements(const std::vector<tool<br>
/// \param[in] FormatStyle Style to apply.<br>
/// \param[in] Diagnostics For diagnostic output.<br>
///<br>
-/// \returns \li true if reformatting replacements were all successfully<br>
+/// \returns \parblock<br>
+/// \li true if reformatting replacements were all successfully<br>
/// applied.<br>
/// \li false if at least one reformatting replacement failed to apply.<br>
static bool<br>
<br>
Modified: clang-tools-extra/trunk/clang-modernize/Core/IncludeDirectives.h<br>
URL: <a href="http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/clang-modernize/Core/IncludeDirectives.h?rev=248080&r1=248079&r2=248080&view=diff" rel="noreferrer" target="_blank">http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/clang-modernize/Core/IncludeDirectives.h?rev=248080&r1=248079&r2=248080&view=diff</a><br>
==============================================================================<br>
--- clang-tools-extra/trunk/clang-modernize/Core/IncludeDirectives.h (original)<br>
+++ clang-tools-extra/trunk/clang-modernize/Core/IncludeDirectives.h Fri Sep 18 21:21:28 2015<br>
@@ -41,7 +41,7 @@ public:<br>
/// \param File A file accessible by a SourceManager<br>
/// \param Include The include file as it should be written in the code.<br>
///<br>
- /// \returns<br>
+ /// \returns \parblock<br>
/// \li A null Replacement (check using \c Replacement::isApplicable()), if<br>
/// the \c Include is already visible from \c File.<br>
/// \li Otherwise, a non-null Replacement that, when applied, inserts an<br>
<br>
Modified: clang-tools-extra/trunk/clang-modernize/Core/ReplacementHandling.h<br>
URL: <a href="http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/clang-modernize/Core/ReplacementHandling.h?rev=248080&r1=248079&r2=248080&view=diff" rel="noreferrer" target="_blank">http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/clang-modernize/Core/ReplacementHandling.h?rev=248080&r1=248079&r2=248080&view=diff</a><br>
==============================================================================<br>
--- clang-tools-extra/trunk/clang-modernize/Core/ReplacementHandling.h (original)<br>
+++ clang-tools-extra/trunk/clang-modernize/Core/ReplacementHandling.h Fri Sep 18 21:21:28 2015<br>
@@ -31,7 +31,8 @@ public:<br>
///<br>
/// \param[in] Argv0 argv[0] as passed to main().<br>
///<br>
- /// \returns \li true if clang-apply-replacements was found.<br>
+ /// \returns \parblock<br>
+ /// \li true if clang-apply-replacements was found.<br>
/// \li false otherwise.<br>
bool findClangApplyReplacements(const char *Argv0);<br>
<br>
@@ -65,7 +66,8 @@ public:<br>
///<br>
/// \param[in] Replacements Container of replacements to serialize.<br>
///<br>
- /// \returns \li true if all replacements were serialized successfully to<br>
+ /// \returns \parblock<br>
+ /// \li true if all replacements were serialized successfully to<br>
/// disk.<br>
/// \li false otherwise.<br>
bool serializeReplacements(const TUReplacementsMap &Replacements);<br>
@@ -76,7 +78,8 @@ public:<br>
/// \pre Destination directory must have been previously set by calling<br>
/// setDestiantionDir() or useTempDestinationDir().<br>
///<br>
- /// \returns \li true if clang-apply-replacements was successfully launched<br>
+ /// \returns \parblock<br>
+ /// \li true if clang-apply-replacements was successfully launched<br>
/// and successfully completed.<br>
/// \li false otherwise.<br>
bool applyReplacements();<br>
@@ -97,7 +100,8 @@ public:<br>
/// \param[out] Error If an error occurs a description of that error is<br>
/// placed in this string.<br>
///<br>
- /// \returns \li true on success<br>
+ /// \returns \parblock<br>
+ /// \li true on success<br>
/// \li false if a unique file name could not be created.<br>
static bool generateReplacementsFileName(llvm::StringRef DestinationDir,<br>
llvm::StringRef MainSourceFile,<br>
<br>
Modified: clang-tools-extra/trunk/clang-modernize/Core/Transform.h<br>
URL: <a href="http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/clang-modernize/Core/Transform.h?rev=248080&r1=248079&r2=248080&view=diff" rel="noreferrer" target="_blank">http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/clang-modernize/Core/Transform.h?rev=248080&r1=248079&r2=248080&view=diff</a><br>
==============================================================================<br>
--- clang-tools-extra/trunk/clang-modernize/Core/Transform.h (original)<br>
+++ clang-tools-extra/trunk/clang-modernize/Core/Transform.h Fri Sep 18 21:21:28 2015<br>
@@ -95,7 +95,8 @@ public:<br>
/// \p SourcePaths.<br>
/// \param[in] SourcePaths list of sources to transform.<br>
///<br>
- /// \returns \li 0 if successful<br>
+ /// \returns \parblock<br>
+ /// \li 0 if successful<br>
/// \li 1 otherwise<br>
virtual int apply(const clang::tooling::CompilationDatabase &Database,<br>
const std::vector<std::string> &SourcePaths) = 0;<br>
@@ -171,7 +172,8 @@ public:<br>
<br>
/// \brief Add a Replacement to the list for the current translation unit.<br>
///<br>
- /// \returns \li true on success<br>
+ /// \returns \parblock<br>
+ /// \li true on success<br>
/// \li false if there is no current translation unit<br>
bool addReplacementForCurrentTU(const clang::tooling::Replacement &R);<br>
<br>
<br>
<br>
_______________________________________________<br>
cfe-commits mailing list<br>
<a href="mailto:cfe-commits@lists.llvm.org">cfe-commits@lists.llvm.org</a><br>
<a href="http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits" rel="noreferrer" target="_blank">http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits</a><br>
</blockquote></div><br></div>