From: Reid Spencer <rspencer@reidspencer.com>
Date: Tue, 11 Jan 2005 06:37:27 +0000 (+0000)
Subject: Fix the documentation for executeAndWait so the argument comments are
X-Git-Url: http://plrg.eecs.uci.edu/git/?a=commitdiff_plain;h=1aa2649fdcc22b67d2c6af16763f8a02ed9daf95;p=oota-llvm.git

Fix the documentation for executeAndWait so the argument comments are
actually attributed to the arguments by doxygen.


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

diff --git a/include/llvm/System/Program.h b/include/llvm/System/Program.h
index 6528d6804ea..b34cab8181f 100644
--- a/include/llvm/System/Program.h
+++ b/include/llvm/System/Program.h
@@ -56,25 +56,22 @@ namespace sys {
       /// @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 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.
-        const char ** env = 0,
-          ///< An optional vector of strings to use for the program's 
-          ///< environment. If not provided, the current program's environment
-          ///< will be used.
-        const sys::Path** redirects = 0,
-          ///< An optional array of pointers to Paths. If the array is null,
-          ///< no redirection is done. The array should have a size of at least
-          ///< three. If the pointer in the array are not null, then the 
-          ///< inferior process's stdin(0), stdout(1), and stderr(2) will be 
-          ///< redirected to the corresponding Paths. 
-        unsigned secondsToWait = 0
-          ///< If non-zero, this specifies the amount of time to wait for the
-          ///< child process to exit. If the time expires, the child is killed
-          ///< and this call returns. If zero, this function will wait until
-          ///< the child finishes or forever if it doesn't.
+        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.
+        const char ** env = 0, ///< An optional vector of strings to use for 
+          ///< the program's environment. If not provided, the current program's
+          ///< environment will be used.
+        const sys::Path** redirects = 0, ///< An optional array of pointers to 
+          ///< Paths. If the array is null, no redirection is done. The array 
+          ///< should have a size of at least three. If the pointer in the array
+          ///< are not null, then the inferior process's stdin(0), stdout(1), 
+          ///< and stderr(2) will be redirected to the corresponding Paths. 
+        unsigned secondsToWait = 0 ///< If non-zero, this specifies the amount 
+          ///< of time to wait for the child process to exit. If the time 
+          ///< expires, the child is killed and this call returns. If zero, 
+          ///< this function will wait until the child finishes or forever if 
+          ///< it doesn't.
       );
   };
 }