aboutsummaryrefslogtreecommitdiff
path: root/include/llvm/System/Program.h
diff options
context:
space:
mode:
authorReid Spencer <rspencer@reidspencer.com>2006-01-08 22:41:22 +0000
committerReid Spencer <rspencer@reidspencer.com>2006-01-08 22:41:22 +0000
commit13a0b6b58f5304310ca093e9a5ad2d656db904cf (patch)
tree617f5c7cab61098b66a3c04557a9980e981e798e /include/llvm/System/Program.h
parentde83cee28b204740aa0801283c5fa22830d70a3c (diff)
Add some documentation.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@25150 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'include/llvm/System/Program.h')
-rw-r--r--include/llvm/System/Program.h2
1 files changed, 2 insertions, 0 deletions
diff --git a/include/llvm/System/Program.h b/include/llvm/System/Program.h
index 8ac421b2b8..fea94d36c3 100644
--- a/include/llvm/System/Program.h
+++ b/include/llvm/System/Program.h
@@ -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