clang-tools-extra: Appease PR24881. [-Wdocumentation]

\returns doesn't accept \li, but \parblock \li.

llvm-svn: 248080

3 files changed, 13 insertions, 7 deletions

diff --git a/clang-tools-extra/clang-modernize/Core/IncludeDirectives.h b/clang-tools-extra/clang-modernize/Core/IncludeDirectives.h
index b2dcbb46f79..577eccfe23b 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 54b9655eefd..c4e79d49c54 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 7c3be9d09f2..511a2bcd39e 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<std::string> &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);