Fix some doxygen usage in these headers.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@28394 91177308-0d34-0410-b5e6-96231b3b80d8

diff --git a/include/llvm/Analysis/DataStructure/DSNode.h b/include/llvm/Analysis/DataStructure/DSNode.h
index 83c9aba5d85d92d44ff7329c8a90290551392641..45937a410622c802a80a3977dcec40af7c681451 100644 (file)
--- a/include/llvm/Analysis/DataStructure/DSNode.h
+++ b/include/llvm/Analysis/DataStructure/DSNode.h
@@ -182,7 +182,7 @@ public:
     delete this;
   }
 
-  /// hasLink - Return true if this memory object has a link in slot #LinkNo
+  /// hasLink - Return true if this memory object has a link in slot LinkNo
   ///
   bool hasLink(unsigned Offset) const {
     assert((Offset & ((1 << DS::PointerShift)-1)) == 0 &&

diff --git a/include/llvm/Assembly/AutoUpgrade.h b/include/llvm/Assembly/AutoUpgrade.h
index 2c959b8e8b7b42229c8b7909fd58e5f5b3c7900d..70c29ab66aa50b3d90027c382b11e46e81bc49b7 100644 (file)
--- a/include/llvm/Assembly/AutoUpgrade.h
+++ b/include/llvm/Assembly/AutoUpgrade.h
@@ -43,9 +43,11 @@ namespace llvm {
   /// if it is a call to an old overloaded intrinsic. If it is, a new CallInst 
   /// is created that uses the correct Function and possibly casts the 
   /// argument and result to an unsigned type.
-  /// @param CI The CallInst to potentially auto-upgrade.
   /// @brief Get replacement instruction for overloaded intrinsic function call.
-  void UpgradeIntrinsicCall(CallInst* CI, Function* newF = 0);
+  void UpgradeIntrinsicCall(
+    CallInst* CI, ///< The CallInst to potentially auto-upgrade.
+    Function* newF = 0 ///< The new function for the call replacement.
+  );
 
   /// Upgrade both the function and all the calls made to it, if that function
   /// needs to be upgraded. This is like a combination of the above two

diff --git a/include/llvm/CodeGen/AsmPrinter.h b/include/llvm/CodeGen/AsmPrinter.h
index b8f00e6e0793a4f8bc83ed9b295db84e40d6ce31..cf65c9ec325eda0ae3f4873cdfb078e9dff403f0 100644 (file)
--- a/include/llvm/CodeGen/AsmPrinter.h
+++ b/include/llvm/CodeGen/AsmPrinter.h
@@ -82,7 +82,8 @@ namespace llvm {
     /// will enclose any GlobalVariable that points to a function.
     /// For example, this is used by the IA64 backend to materialize
     /// function descriptors, by decorating the ".data8" object with the
-    /// @fptr( ) link-relocation operator.
+    /// \literal @fptr( ) \endliteral
+    /// link-relocation operator.
     ///
     const char *FunctionAddrPrefix;       // Defaults to ""
     const char *FunctionAddrSuffix;       // Defaults to ""
@@ -173,7 +174,8 @@ namespace llvm {
     /// LCOMMDirective - This is the name of a directive (if supported) that can
     /// be used to efficiently declare a local (internal) block of zero
     /// initialized data in the .bss/.data section.  The syntax expected is:
-    ///    <LCOMMDirective> SYMBOLNAME LENGTHINBYTES, ALIGNMENT
+    /// \literal <LCOMMDirective> SYMBOLNAME LENGTHINBYTES, ALIGNMENT
+    /// \endliteral
     const char *LCOMMDirective;          // Defaults to null.
     
     const char *COMMDirective;           // Defaults to "\t.comm\t".

diff --git a/include/llvm/CodeGen/DwarfWriter.h b/include/llvm/CodeGen/DwarfWriter.h
index c08cf4ebecbbcc3c95a6e460cdb8ff669f572f5e..1575fbe785f0e5352906bdb1e08e2d6f501cd4ef 100644 (file)
--- a/include/llvm/CodeGen/DwarfWriter.h
+++ b/include/llvm/CodeGen/DwarfWriter.h
@@ -279,7 +279,8 @@ public:
   void EmitInt64(uint64_t Value) const;
   
   /// EmitString - Emit a string with quotes and a null terminator.
-  /// Special characters are emitted properly. (Eg. '\t')
+  /// Special characters are emitted properly. 
+  /// \literal (Eg. '\t') \endliteral
   void EmitString(const std::string &String) const;
 
   /// PrintLabelName - Print label name in form used by Dwarf writer.

diff --git a/include/llvm/Instructions.h b/include/llvm/Instructions.h
index bedb6454b6ed66fe7c2748769ed3c1c5887261bc..0f92293f20f800fba4103487d6f4149da547eac1 100644 (file)
--- a/include/llvm/Instructions.h
+++ b/include/llvm/Instructions.h
@@ -927,7 +927,7 @@ public:
   ///
   unsigned getNumIncomingValues() const { return getNumOperands()/2; }
 
-  /// getIncomingValue - Return incoming value #x
+  /// getIncomingValue - Return incoming value number x
   ///
   Value *getIncomingValue(unsigned i) const {
     assert(i*2 < getNumOperands() && "Invalid value number!");
@@ -941,7 +941,7 @@ public:
     return i*2;
   }
 
-  /// getIncomingBlock - Return incoming basic block #x
+  /// getIncomingBlock - Return incoming basic block number x
   ///
   BasicBlock *getIncomingBlock(unsigned i) const {
     return reinterpret_cast<BasicBlock*>(getOperand(i*2+1));

diff --git a/include/llvm/System/DynamicLibrary.h b/include/llvm/System/DynamicLibrary.h
index 1aea0460a22826d6cf2acadf7fe173b4d8158538..f90126c7360bdcc096a68c9c5ae088cfbd83c558 100644 (file)
--- a/include/llvm/System/DynamicLibrary.h
+++ b/include/llvm/System/DynamicLibrary.h
@@ -45,7 +45,7 @@ namespace sys {
       DynamicLibrary();
 
       /// This is the constructor for DynamicLibrary instances. It will open
-      /// the dynamic library specified by the \filename Path.
+      /// the dynamic library specified by the filename Path.
       /// @throws std::string indicating why the library couldn't be opened.
       /// @brief Open a dynamic library.
       DynamicLibrary(const char* filename);

diff --git a/include/llvm/System/Program.h b/include/llvm/System/Program.h
index fea94d36c350494b01acbac07ca910e9b1ad6632..2f33ea574608e7ec17aaef404c3e0d64f43036f3 100644 (file)
--- a/include/llvm/System/Program.h
+++ b/include/llvm/System/Program.h
@@ -46,9 +46,6 @@ namespace sys {
       /// environment and other configuration settings of the invoking program.
       /// If Path::executable() does not return true when this function is
       /// called then a std::string is thrown.
-      /// @param path A sys::Path object providing the path of the program to be
-      /// executed. It is presumed this is the result of the FindProgramByName
-      /// method.
       /// @returns an integer result code indicating the status of the program.
       /// A zero or positive value indicates the result code of the program. A
       /// negative value is the signal number on which it terminated.
@@ -57,7 +54,9 @@ namespace sys {
       /// @see FindProgrambyName
       /// @brief Executes the program with the given set of \p args.
       static int ExecuteAndWait(
-        const Path& path,  ///< The path to the program to execute
+        const Path& path,  ///< sys::Path object providing the path of the 
+          ///< program to be executed. It is presumed this is the result of 
+          ///< the FindProgramByName method.
         const char** args, ///< A vector of strings that are passed to the
           ///< program.  The first element should be the name of the program.
           ///< The list *must* be terminated by a null char* entry.