Fix minor doxygen nits.

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

10 files changed, 29 insertions, 22 deletions

diff --git a/include/llvm/Bitcode/Archive.h b/include/llvm/Bitcode/Archive.h
index 980bd07..39ad5eb 100644
--- a/include/llvm/Bitcode/Archive.h
+++ b/include/llvm/Bitcode/Archive.h
@@ -463,6 +463,8 @@ class Archive {
     /// into memory.
     Archive(const sys::Path& filename);
 
+    /// @param data The symbol table data to be parsed
+    /// @param len  The length of the symbol table data
     /// @param error Set to address of a std::string to get error messages
     /// @returns false on error
     /// @brief Parse the symbol table at \p data.
@@ -476,17 +478,17 @@ class Archive {
       std::string* error ///< Optional error message catcher
     );
 
-    /// @param error Set to address of a std::string to get error messages
+    /// @param ErrMessage Set to address of a std::string to get error messages
     /// @returns false on error
     /// @brief Check that the archive signature is correct
     bool checkSignature(std::string* ErrMessage);
 
-    /// @param error Set to address of a std::string to get error messages
+    /// @param ErrMessage Set to address of a std::string to get error messages
     /// @returns false on error
     /// @brief Load the entire archive.
     bool loadArchive(std::string* ErrMessage);
 
-    /// @param error Set to address of a std::string to get error messages
+    /// @param ErrMessage Set to address of a std::string to get error messages
     /// @returns false on error
     /// @brief Load just the symbol table.
     bool loadSymbolTable(std::string* ErrMessage);
diff --git a/include/llvm/CodeGen/AsmPrinter.h b/include/llvm/CodeGen/AsmPrinter.h
index b848276..4331387 100644
--- a/include/llvm/CodeGen/AsmPrinter.h
+++ b/include/llvm/CodeGen/AsmPrinter.h
@@ -240,7 +240,7 @@ namespace llvm {
 
     /// EmitString - Emit a string with quotes and a null terminator.
     /// Special characters are emitted properly.
-    /// \literal (Eg. '\t') \endliteral
+    /// @verbatim (Eg. '\t') @endverbatim
     void EmitString(const std::string &String) const;
     
     //===------------------------------------------------------------------===//
diff --git a/include/llvm/Constants.h b/include/llvm/Constants.h
index 526f19c..bb32a1b 100644
--- a/include/llvm/Constants.h
+++ b/include/llvm/Constants.h
@@ -311,7 +311,9 @@ public:
   bool isString() const;
 
   /// isCString - This method returns true if the array is a string (see
+  /// @verbatim
   /// isString) and it ends in a null byte \0 and does not contains any other
+  /// @endverbatim
   /// null bytes except its terminator.
   bool isCString() const;
 
diff --git a/include/llvm/Linker.h b/include/llvm/Linker.h
index cc0372d..8c53b34 100644
--- a/include/llvm/Linker.h
+++ b/include/llvm/Linker.h
@@ -204,7 +204,7 @@ class Linker {
     /// found in one library, based on the unresolved symbols in the composite
     /// module.The \p Library should be the base name of a library, as if given
     /// with the -l option of a linker tool. The Linker's LibPaths are searched
-    /// for the \P Library and if found, it will be linked in with via the
+    /// for the \p Library and if found, it will be linked in with via the
     /// LinkInArchive method. If an error occurs, the Linker's error string is
     /// set.
     /// @see LinkInArchive
diff --git a/include/llvm/Support/LLVMBuilder.h b/include/llvm/Support/LLVMBuilder.h
index bd450dc..042db94 100644
--- a/include/llvm/Support/LLVMBuilder.h
+++ b/include/llvm/Support/LLVMBuilder.h
@@ -89,7 +89,7 @@ public:
     return Insert(new ReturnInst());
   }
 
-  /// CreateRet - Create a 'ret <val>' instruction.
+  /// @verbatim CreateRet - Create a 'ret <val>' instruction. @endverbatim
   ReturnInst *CreateRet(Value *V) {
     return Insert(new ReturnInst(V));
   }
diff --git a/include/llvm/Support/Mangler.h b/include/llvm/Support/Mangler.h
index b6f9839..1cbc13c 100644
--- a/include/llvm/Support/Mangler.h
+++ b/include/llvm/Support/Mangler.h
@@ -71,7 +71,7 @@ public:
   void setUseQuotes(bool Val) { UseQuotes = Val; }
   
   /// setPreserveAsmNames - If the mangler should not strip off the asm name
-  /// identifier (\001), this should be set.
+  /// @verbatim identifier (\001), this should be set. @endverbatim
   void setPreserveAsmNames(bool Val) { PreserveAsmNames = Val; }
   
   /// Acceptable Characters - This allows the target to specify which characters
diff --git a/include/llvm/Support/MemoryBuffer.h b/include/llvm/Support/MemoryBuffer.h
index d7e0317..bc61c34 100644
--- a/include/llvm/Support/MemoryBuffer.h
+++ b/include/llvm/Support/MemoryBuffer.h
@@ -23,7 +23,7 @@ namespace llvm {
 /// of memory, and provides simple methods for reading files and standard input
 /// into a memory buffer.  In addition to basic access to the characters in the
 /// file, this interface guarantees you can read one character past the end of
-/// the file, and that this character will read as '\0'.
+/// @verbatim the file, and that this character will read as '\0'. @endverbatim
 class MemoryBuffer {
   const char *BufferStart; // Start of the buffer.
   const char *BufferEnd;   // End of the buffer.
diff --git a/include/llvm/Support/Streams.h b/include/llvm/Support/Streams.h
index 4e1e4f3..6758c35 100644
--- a/include/llvm/Support/Streams.h
+++ b/include/llvm/Support/Streams.h
@@ -21,8 +21,8 @@ namespace llvm {
 
   /// BaseStream - Acts like the STL streams. It's a wrapper for the std::cerr,
   /// std::cout, std::cin, etc. streams. However, it doesn't require #including
-  /// <iostream> in every file (doing so increases static c'tors & d'tors in the
-  /// object code).
+  /// @verbatim <iostream> @endverbatm in every file (doing so increases static 
+  /// c'tors & d'tors in the object code).
   /// 
   template <typename StreamTy>
   class BaseStream {
diff --git a/include/llvm/System/Path.h b/include/llvm/System/Path.h
index e7aa45b..aec7399 100644
--- a/include/llvm/System/Path.h
+++ b/include/llvm/System/Path.h
@@ -177,7 +177,8 @@ namespace sys {
       /// This constructor will accept a character range as a path.  No checking
       /// is done on this path to determine if it is valid.  To determine
       /// validity of the path, use the isValid method. 
-      /// @param p The path to assign.
+      /// @param StrStart A pointer to the first character of the path name
+      /// @param StrLen The length of the path name at StrStart
       /// @brief Construct a Path from a string.
       explicit Path(const char *StrStart, unsigned StrLen)
         : path(StrStart, StrStart+StrLen) {}
@@ -280,7 +281,7 @@ namespace sys {
 
       /// This function determines if the path name is absolute, as opposed to
       /// relative. 
-      /// @breif Determine if the path is absolute.
+      /// @brief Determine if the path is absolute.
       bool isAbsolute() const;
 
       /// This function opens the file associated with the path name provided by
@@ -512,6 +513,7 @@ namespace sys {
       /// directory, recursively. If the Path refers to a file, the
       /// \p destroy_contents parameter is ignored.
       /// @param destroy_contents Indicates whether the contents of a destroyed
+      /// @param Err An optional string to receive an error message.
       /// directory should also be destroyed (recursively).
       /// @returns false if the file/directory was destroyed, true on error.
       /// @brief Removes the file or directory from the filesystem.
@@ -554,18 +556,19 @@ namespace sys {
       /// This constructor will accept a std::string as a path. No checking is
       /// done on this path to determine if it is valid. To determine validity
       /// of the path, use the isValid method. 
-      /// @param p The path to assign.
       /// @brief Construct a Path from a string.
-      explicit PathWithStatus(const std::string& p) 
-        : Path(p), status(), fsIsValid(false) {}
+      explicit PathWithStatus(
+        const std::string& p ///< The path to assign.
+      ) : Path(p), status(), fsIsValid(false) {}
 
       /// This constructor will accept a character range as a path.  No checking
       /// is done on this path to determine if it is valid.  To determine
       /// validity of the path, use the isValid method. 
-      /// @param p The path to assign.
       /// @brief Construct a Path from a string.
-      explicit PathWithStatus(const char *StrStart, unsigned StrLen)
-        : Path(StrStart, StrLen), status(), fsIsValid(false) {}
+      explicit PathWithStatus(
+        const char *StrStart,  ///< Pointer to the first character of the path
+        unsigned StrLen        ///< Length of the path.
+      ) : Path(StrStart, StrLen), status(), fsIsValid(false) {}
 
       /// Makes a copy of \p that to \p this.
       /// @returns \p this
diff --git a/include/llvm/Target/TargetAsmInfo.h b/include/llvm/Target/TargetAsmInfo.h
index 4e6d3b9..92d6192 100644
--- a/include/llvm/Target/TargetAsmInfo.h
+++ b/include/llvm/Target/TargetAsmInfo.h
@@ -104,7 +104,7 @@ 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
-    /// \literal @fptr( ) \endliteral
+    /// @verbatim @fptr( ) @endverbatim
     /// link-relocation operator.
     ///
     const char *FunctionAddrPrefix;       // Defaults to ""
@@ -190,7 +190,7 @@ namespace llvm {
     const char *JumpTableDirective;
 
     /// CStringSection - If not null, this allows for special handling of
-    /// cstring constants (\0 terminated string that does not contain any
+    /// cstring constants (null terminated string that does not contain any
     /// other null bytes) on this target. This is commonly supported as
     /// ".cstring".
     const char *CStringSection;           // Defaults to NULL
@@ -230,8 +230,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:
-    /// \literal <LCOMMDirective> SYMBOLNAME LENGTHINBYTES, ALIGNMENT
-    /// \endliteral
+    /// @verbatim <LCOMMDirective> SYMBOLNAME LENGTHINBYTES, ALIGNMENT
+    /// @endverbatim
     const char *LCOMMDirective;           // Defaults to null.
     
     const char *COMMDirective;            // Defaults to "\t.comm\t".