[llvm] d5ea89f - Quiet some -Wdocumentation warnings.

[Benjamin Kramer via llvm-commits]

Author: Benjamin Kramer
Date: 2020-05-06T11:23:13+02:00
New Revision: d5ea89f8914fcf7e5f637202c6972cb14617d93d

URL: https://github.com/llvm/llvm-project/commit/d5ea89f8914fcf7e5f637202c6972cb14617d93d
DIFF: https://github.com/llvm/llvm-project/commit/d5ea89f8914fcf7e5f637202c6972cb14617d93d.diff

LOG: Quiet some -Wdocumentation warnings.

Added: 
    

Modified: 
    clang/include/clang/AST/PrettyPrinter.h
    llvm/include/llvm/Support/DataExtractor.h
    llvm/lib/Transforms/Scalar/LoopDataPrefetch.cpp

Removed: 
    


################################################################################
diff  --git a/clang/include/clang/AST/PrettyPrinter.h b/clang/include/clang/AST/PrettyPrinter.h
index 65c7e2385677..616647f44430 100644
--- a/clang/include/clang/AST/PrettyPrinter.h
+++ b/clang/include/clang/AST/PrettyPrinter.h
@@ -184,8 +184,8 @@ struct PrintingPolicy {
   /// with zero parameters.
   unsigned UseVoidForZeroParams : 1;
 
-  /// Whether nested templates must be closed like 'a<b<c> >' rather than
-  /// 'a<b<c>>'.
+  /// Whether nested templates must be closed like 'a\<b\<c\> \>' rather than
+  /// 'a\<b\<c\>\>'.
   unsigned SplitTemplateClosers : 1;
 
   /// Provide a 'terse' output.

diff  --git a/llvm/include/llvm/Support/DataExtractor.h b/llvm/include/llvm/Support/DataExtractor.h
index 9a23d8ab1d3c..eb0edd11aa96 100644
--- a/llvm/include/llvm/Support/DataExtractor.h
+++ b/llvm/include/llvm/Support/DataExtractor.h
@@ -105,7 +105,7 @@ class DataExtractor {
   /// updated with the offset of the byte that follows the NULL
   /// terminator byte.
   ///
-  /// @param[in,out] offset_ptr
+  /// @param[in,out] OffsetPtr
   ///     A pointer to an offset within the data that will be advanced
   ///     by the appropriate number of bytes if the value is extracted
   ///     correctly. If the offset is out of bounds or there are not
@@ -140,7 +140,7 @@ class DataExtractor {
   /// updated with the offset of the byte that follows the NULL
   /// terminator byte.
   ///
-  /// \param[in,out] offset_ptr
+  /// \param[in,out] OffsetPtr
   ///     A pointer to an offset within the data that will be advanced
   ///     by the appropriate number of bytes if the value is extracted
   ///     correctly. If the offset is out of bounds or there are not
@@ -461,7 +461,7 @@ class DataExtractor {
   /// \a offset_ptr, construct a uint32_t from them and update the offset
   /// on success.
   ///
-  /// @param[in,out] offset_ptr
+  /// @param[in,out] OffsetPtr
   ///     A pointer to an offset within the data that will be advanced
   ///     by the 3 bytes if the value is extracted correctly. If the offset
   ///     is out of bounds or there are not enough bytes to extract this value,
@@ -593,7 +593,7 @@ class DataExtractor {
   /// pointed to by \a offset_ptr will be updated with the offset of
   /// the byte following the last extracted byte.
   ///
-  /// @param[in,out] offset_ptr
+  /// @param[in,out] OffsetPtr
   ///     A pointer to an offset within the data that will be advanced
   ///     by the appropriate number of bytes if the value is extracted
   ///     correctly. If the offset is out of bounds or there are not

diff  --git a/llvm/lib/Transforms/Scalar/LoopDataPrefetch.cpp b/llvm/lib/Transforms/Scalar/LoopDataPrefetch.cpp
index de333577bb90..ea2c3bb90d4d 100644
--- a/llvm/lib/Transforms/Scalar/LoopDataPrefetch.cpp
+++ b/llvm/lib/Transforms/Scalar/LoopDataPrefetch.cpp
@@ -236,7 +236,7 @@ struct Prefetch {
   /// The (first seen) prefetched instruction.
   Instruction *MemI;
 
-  /// Constructor to create a new Prefetch for \param I.
+  /// Constructor to create a new Prefetch for \p I.
   Prefetch(const SCEVAddRecExpr *L, Instruction *I)
       : LSCEVAddRec(L), InsertPt(nullptr), Writes(false), MemI(nullptr) {
     addInstruction(I);