[llvm] 02946de - [Support][NFC] Fix Wdocumentation warning in ADT/Bitfields.h

Bruno Ricci via llvm-commits llvm-commits at lists.llvm.org
Mon Jul 6 14:42:39 PDT 2020


Author: Bruno Ricci
Date: 2020-07-06T22:41:40+01:00
New Revision: 02946de3802d3bc65bc9f2eb9b8d4969b5a7add8

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

LOG: [Support][NFC] Fix Wdocumentation warning in ADT/Bitfields.h

\tparam is used for template parameters instead of \param.

Added: 
    

Modified: 
    llvm/include/llvm/ADT/Bitfields.h

Removed: 
    


################################################################################
diff  --git a/llvm/include/llvm/ADT/Bitfields.h b/llvm/include/llvm/ADT/Bitfields.h
index 68b1549a0ac5..9891b4692e80 100644
--- a/llvm/include/llvm/ADT/Bitfields.h
+++ b/llvm/include/llvm/ADT/Bitfields.h
@@ -212,10 +212,10 @@ template <> struct ResolveUnderlyingType<bool, false> {
 struct Bitfield {
   /// Describes an element of a Bitfield. This type is then used with the
   /// Bitfield static member functions.
-  /// \param T, the type of the field once in unpacked form,
-  /// \param Offset, the position of the first bit,
-  /// \param Size, the size of the field,
-  /// \param MaxValue, For enums the maximum enum allowed.
+  /// \tparam T         The type of the field once in unpacked form.
+  /// \tparam Offset    The position of the first bit.
+  /// \tparam Size      The size of the field.
+  /// \tparam MaxValue  For enums the maximum enum allowed.
   template <typename T, unsigned Offset, unsigned Size,
             T MaxValue = std::is_enum<T>::value
                              ? T(0) // coupled with static_assert below


        


More information about the llvm-commits mailing list