[llvm-commits] CVS: llvm/include/llvm/System/DynamicLibrary.h Program.h

[Reid Spencer]

Changes in directory llvm/include/llvm/System:

DynamicLibrary.h updated: 1.5 -> 1.6
Program.h updated: 1.8 -> 1.9
---
Log message:

Fix some doxygen usage in these headers.


---
Diffs of the changes:  (+4 -5)

 DynamicLibrary.h |    2 +-
 Program.h        |    7 +++----
 2 files changed, 4 insertions(+), 5 deletions(-)


Index: llvm/include/llvm/System/DynamicLibrary.h
diff -u llvm/include/llvm/System/DynamicLibrary.h:1.5 llvm/include/llvm/System/DynamicLibrary.h:1.6
--- llvm/include/llvm/System/DynamicLibrary.h:1.5	Sun Jan 29 22:33:51 2006
+++ llvm/include/llvm/System/DynamicLibrary.h	Fri May 19 14:07:54 2006
@@ -45,7 +45,7 @@
       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);


Index: llvm/include/llvm/System/Program.h
diff -u llvm/include/llvm/System/Program.h:1.8 llvm/include/llvm/System/Program.h:1.9
--- llvm/include/llvm/System/Program.h:1.8	Sun Jan  8 16:41:22 2006
+++ llvm/include/llvm/System/Program.h	Fri May 19 14:07:54 2006
@@ -46,9 +46,6 @@
       /// 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 @@
       /// @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.