thr3ads.net - llvm dev - [LLVMdev] [PATCH] Fix off-by-one errors in the doxygen documentation [Feb 2010]

If this information is useful, please help other people find it:
Share via:

Peter Collingbourne

2010-Feb-12 19:22 UTC

[LLVMdev] [PATCH] Fix off-by-one errors in the doxygen documentation

Some doxygen annotations are attached to the wrong entry, which can be
misleading.  This patch fixes the mistake everywhere I could find it.
---
 include/llvm/InstrTypes.h      |   54 ++++++++++++++++++++--------------------
 include/llvm/MC/MCDirectives.h |   42 +++++++++++++++---------------
 include/llvm/Pass.h            |   10 +++---
 3 files changed, 53 insertions(+), 53 deletions(-)

diff --git a/include/llvm/InstrTypes.h b/include/llvm/InstrTypes.h
index 5ce1a9d..49cdd6a 100644
--- a/include/llvm/InstrTypes.h
+++ b/include/llvm/InstrTypes.h
@@ -696,36 +696,36 @@ public:
   /// range 32-64 are reserved for ICmpInst. This is necessary to ensure the
   /// predicate values are not overlapping between the classes.
   enum Predicate {
-    // Opcode             U L G E    Intuitive operation
-    FCMP_FALSE =  0,  /// 0 0 0 0    Always false (always folded)
-    FCMP_OEQ   =  1,  /// 0 0 0 1    True if ordered and equal
-    FCMP_OGT   =  2,  /// 0 0 1 0    True if ordered and greater than
-    FCMP_OGE   =  3,  /// 0 0 1 1    True if ordered and greater than or equal
-    FCMP_OLT   =  4,  /// 0 1 0 0    True if ordered and less than
-    FCMP_OLE   =  5,  /// 0 1 0 1    True if ordered and less than or equal
-    FCMP_ONE   =  6,  /// 0 1 1 0    True if ordered and operands are unequal
-    FCMP_ORD   =  7,  /// 0 1 1 1    True if ordered (no nans)
-    FCMP_UNO   =  8,  /// 1 0 0 0    True if unordered: isnan(X) | isnan(Y)
-    FCMP_UEQ   =  9,  /// 1 0 0 1    True if unordered or equal
-    FCMP_UGT   = 10,  /// 1 0 1 0    True if unordered or greater than
-    FCMP_UGE   = 11,  /// 1 0 1 1    True if unordered, greater than, or equal
-    FCMP_ULT   = 12,  /// 1 1 0 0    True if unordered or less than
-    FCMP_ULE   = 13,  /// 1 1 0 1    True if unordered, less than, or equal
-    FCMP_UNE   = 14,  /// 1 1 1 0    True if unordered or not equal
-    FCMP_TRUE  = 15,  /// 1 1 1 1    Always true (always folded)
+    // Opcode              U L G E    Intuitive operation
+    FCMP_FALSE =  0,  ///< 0 0 0 0    Always false (always folded)
+    FCMP_OEQ   =  1,  ///< 0 0 0 1    True if ordered and equal
+    FCMP_OGT   =  2,  ///< 0 0 1 0    True if ordered and greater than
+    FCMP_OGE   =  3,  ///< 0 0 1 1    True if ordered and greater than or
equal
+    FCMP_OLT   =  4,  ///< 0 1 0 0    True if ordered and less than
+    FCMP_OLE   =  5,  ///< 0 1 0 1    True if ordered and less than or equal
+    FCMP_ONE   =  6,  ///< 0 1 1 0    True if ordered and operands are
unequal
+    FCMP_ORD   =  7,  ///< 0 1 1 1    True if ordered (no nans)
+    FCMP_UNO   =  8,  ///< 1 0 0 0    True if unordered: isnan(X) | isnan(Y)
+    FCMP_UEQ   =  9,  ///< 1 0 0 1    True if unordered or equal
+    FCMP_UGT   = 10,  ///< 1 0 1 0    True if unordered or greater than
+    FCMP_UGE   = 11,  ///< 1 0 1 1    True if unordered, greater than, or
equal
+    FCMP_ULT   = 12,  ///< 1 1 0 0    True if unordered or less than
+    FCMP_ULE   = 13,  ///< 1 1 0 1    True if unordered, less than, or equal
+    FCMP_UNE   = 14,  ///< 1 1 1 0    True if unordered or not equal
+    FCMP_TRUE  = 15,  ///< 1 1 1 1    Always true (always folded)
     FIRST_FCMP_PREDICATE = FCMP_FALSE,
     LAST_FCMP_PREDICATE = FCMP_TRUE,
     BAD_FCMP_PREDICATE = FCMP_TRUE + 1,
-    ICMP_EQ    = 32,  /// equal
-    ICMP_NE    = 33,  /// not equal
-    ICMP_UGT   = 34,  /// unsigned greater than
-    ICMP_UGE   = 35,  /// unsigned greater or equal
-    ICMP_ULT   = 36,  /// unsigned less than
-    ICMP_ULE   = 37,  /// unsigned less or equal
-    ICMP_SGT   = 38,  /// signed greater than
-    ICMP_SGE   = 39,  /// signed greater or equal
-    ICMP_SLT   = 40,  /// signed less than
-    ICMP_SLE   = 41,  /// signed less or equal
+    ICMP_EQ    = 32,  ///< equal
+    ICMP_NE    = 33,  ///< not equal
+    ICMP_UGT   = 34,  ///< unsigned greater than
+    ICMP_UGE   = 35,  ///< unsigned greater or equal
+    ICMP_ULT   = 36,  ///< unsigned less than
+    ICMP_ULE   = 37,  ///< unsigned less or equal
+    ICMP_SGT   = 38,  ///< signed greater than
+    ICMP_SGE   = 39,  ///< signed greater or equal
+    ICMP_SLT   = 40,  ///< signed less than
+    ICMP_SLE   = 41,  ///< signed less or equal
     FIRST_ICMP_PREDICATE = ICMP_EQ,
     LAST_ICMP_PREDICATE = ICMP_SLE,
     BAD_ICMP_PREDICATE = ICMP_SLE + 1
diff --git a/include/llvm/MC/MCDirectives.h b/include/llvm/MC/MCDirectives.h
index 609a9a4..1f7364d 100644
--- a/include/llvm/MC/MCDirectives.h
+++ b/include/llvm/MC/MCDirectives.h
@@ -17,32 +17,32 @@
 namespace llvm {
 
 enum MCSymbolAttr {
-  MCSA_Invalid = 0,    /// Not a valid directive.
+  MCSA_Invalid = 0,    ///< Not a valid directive.
 
   // Various directives in alphabetical order.
-  MCSA_ELF_TypeFunction,    /// .type _foo, STT_FUNC  # aka @function
-  MCSA_ELF_TypeIndFunction, /// .type _foo, STT_GNU_IFUNC
-  MCSA_ELF_TypeObject,      /// .type _foo, STT_OBJECT  # aka @object
-  MCSA_ELF_TypeTLS,         /// .type _foo, STT_TLS     # aka @tls_object
-  MCSA_ELF_TypeCommon,      /// .type _foo, STT_COMMON  # aka @common
-  MCSA_ELF_TypeNoType,      /// .type _foo, STT_NOTYPE  # aka @notype
-  MCSA_Global,              /// .globl
-  MCSA_Hidden,              /// .hidden (ELF)
-  MCSA_IndirectSymbol,      /// .indirect_symbol (MachO)
-  MCSA_Internal,            /// .internal (ELF)
-  MCSA_LazyReference,       /// .lazy_reference (MachO)
-  MCSA_Local,               /// .local (ELF)
-  MCSA_NoDeadStrip,         /// .no_dead_strip (MachO)
-  MCSA_PrivateExtern,       /// .private_extern (MachO)
-  MCSA_Protected,           /// .protected (ELF)
-  MCSA_Reference,           /// .reference (MachO)
-  MCSA_Weak,                /// .weak
-  MCSA_WeakDefinition,      /// .weak_definition (MachO)
-  MCSA_WeakReference        /// .weak_reference (MachO)
+  MCSA_ELF_TypeFunction,    ///< .type _foo, STT_FUNC  # aka @function
+  MCSA_ELF_TypeIndFunction, ///< .type _foo, STT_GNU_IFUNC
+  MCSA_ELF_TypeObject,      ///< .type _foo, STT_OBJECT  # aka @object
+  MCSA_ELF_TypeTLS,         ///< .type _foo, STT_TLS     # aka @tls_object
+  MCSA_ELF_TypeCommon,      ///< .type _foo, STT_COMMON  # aka @common
+  MCSA_ELF_TypeNoType,      ///< .type _foo, STT_NOTYPE  # aka @notype
+  MCSA_Global,              ///< .globl
+  MCSA_Hidden,              ///< .hidden (ELF)
+  MCSA_IndirectSymbol,      ///< .indirect_symbol (MachO)
+  MCSA_Internal,            ///< .internal (ELF)
+  MCSA_LazyReference,       ///< .lazy_reference (MachO)
+  MCSA_Local,               ///< .local (ELF)
+  MCSA_NoDeadStrip,         ///< .no_dead_strip (MachO)
+  MCSA_PrivateExtern,       ///< .private_extern (MachO)
+  MCSA_Protected,           ///< .protected (ELF)
+  MCSA_Reference,           ///< .reference (MachO)
+  MCSA_Weak,                ///< .weak
+  MCSA_WeakDefinition,      ///< .weak_definition (MachO)
+  MCSA_WeakReference        ///< .weak_reference (MachO)
 };
 
 enum MCAssemblerFlag {
-  MCAF_SubsectionsViaSymbols  /// .subsections_via_symbols (MachO)
+  MCAF_SubsectionsViaSymbols  ///< .subsections_via_symbols (MachO)
 };
   
 } // end namespace llvm
diff --git a/include/llvm/Pass.h b/include/llvm/Pass.h
index ab08afb..e822a0f 100644
--- a/include/llvm/Pass.h
+++ b/include/llvm/Pass.h
@@ -56,11 +56,11 @@ typedef const PassInfo* AnalysisID;
 /// Ordering of pass manager types is important here.
 enum PassManagerType {
   PMT_Unknown = 0,
-  PMT_ModulePassManager = 1, /// MPPassManager 
-  PMT_CallGraphPassManager,  /// CGPassManager
-  PMT_FunctionPassManager,   /// FPPassManager
-  PMT_LoopPassManager,       /// LPPassManager
-  PMT_BasicBlockPassManager, /// BBPassManager
+  PMT_ModulePassManager = 1, ///< MPPassManager 
+  PMT_CallGraphPassManager,  ///< CGPassManager
+  PMT_FunctionPassManager,   ///< FPPassManager
+  PMT_LoopPassManager,       ///< LPPassManager
+  PMT_BasicBlockPassManager, ///< BBPassManager
   PMT_Last
 };
 
-- 
1.6.5


-- 
Peter

Chris Lattner

2010-Feb-12 19:42 UTC

head link

[LLVMdev] [PATCH] Fix off-by-one errors in the doxygen documentation

On Feb 12, 2010, at 11:22 AM, Peter Collingbourne wrote:
> Some doxygen annotations are attached to the wrong entry, which can be
> misleading.  This patch fixes the mistake everywhere I could find it.
Nice, please send this patch as a non-inline attachment and I'll be happy to
apply it,

-Chris

Peter Collingbourne

2010-Feb-12 21:44 UTC

head link

[LLVMdev] [PATCH] Fix off-by-one errors in the doxygen documentation

On Fri, Feb 12, 2010 at 11:42:59AM -0800, Chris Lattner
wrote:> 
> On Feb 12, 2010, at 11:22 AM, Peter Collingbourne wrote:
> 
> > Some doxygen annotations are attached to the wrong entry, which can be
> > misleading.  This patch fixes the mistake everywhere I could find it.
> 
> Nice, please send this patch as a non-inline attachment and I'll be
happy to apply it,
Thanks Chris, please see attached.

-- 
Peter
-------------- next part --------------
A non-text attachment was scrubbed...
Name: 0001-Fix-off-by-one-errors-in-the-doxygen-documentation.patch
Type: text/x-diff
Size: 8145 bytes
Desc: not available
URL:
<http://lists.llvm.org/pipermail/llvm-dev/attachments/20100212/b3472004/attachment.patch>

Reasonably Related Threads

Search for more possibly parallel threads

llvm dev - Feb 2010 - [LLVMdev] [PATCH] Fix off-by-one errors in the doxygen documentation

[LLVMdev] [PATCH] Fix off-by-one errors in the doxygen documentation

[LLVMdev] [PATCH] Fix off-by-one errors in the doxygen documentation

[LLVMdev] [PATCH] Fix off-by-one errors in the doxygen documentation

Reasonably Related Threads