Add some documentation.
authorReid Spencer <rspencer@reidspencer.com>
Sun, 8 Jan 2006 22:41:22 +0000 (22:41 +0000)
committerReid Spencer <rspencer@reidspencer.com>
Sun, 8 Jan 2006 22:41:22 +0000 (22:41 +0000)
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@25150 91177308-0d34-0410-b5e6-96231b3b80d8

include/llvm/System/Program.h

index 8ac421b2b8542c862af013d31db1816c7600db2b..fea94d36c350494b01acbac07ca910e9b1ad6632 100644 (file)
@@ -50,6 +50,8 @@ namespace sys {
       /// 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.
       /// @throws std::string on a variety of error conditions or if the invoked
       /// program aborted abnormally.
       /// @see FindProgrambyName