summaryrefslogtreecommitdiff
path: root/include/llvm/Argument.h
diff options
context:
space:
mode:
authorReid Spencer <rspencer@reidspencer.com>2006-06-05 16:29:06 +0000
committerReid Spencer <rspencer@reidspencer.com>2006-06-05 16:29:06 +0000
commitbddcb9427cb36ac6609fef233eaac3c9b5e5a8f4 (patch)
tree2560e148ff31e45331953aabbabe61335f1b5186 /include/llvm/Argument.h
parentfcadfbbdef6c87cf3952142e396e5872e30da8a3 (diff)
downloadllvm-bddcb9427cb36ac6609fef233eaac3c9b5e5a8f4.tar.gz
llvm-bddcb9427cb36ac6609fef233eaac3c9b5e5a8f4.tar.bz2
llvm-bddcb9427cb36ac6609fef233eaac3c9b5e5a8f4.tar.xz
For PR778:
Move file-scoped documentation to class-scoped so it is more readily accessible. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@28689 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'include/llvm/Argument.h')
-rw-r--r--include/llvm/Argument.h8
1 files changed, 6 insertions, 2 deletions
diff --git a/include/llvm/Argument.h b/include/llvm/Argument.h
index 6c567e200a..1751c21ce2 100644
--- a/include/llvm/Argument.h
+++ b/include/llvm/Argument.h
@@ -7,8 +7,7 @@
//
//===----------------------------------------------------------------------===//
//
-// This file defines the Argument class, which represents an incoming formal
-// argument to a Function.
+// This file declares the Argument class.
//
//===----------------------------------------------------------------------===//
@@ -23,6 +22,11 @@ template<typename SC> struct ilist_traits;
template<typename ValueSubClass, typename ItemParentClass, typename SymTabClass,
typename SubClass> class SymbolTableListTraits;
+/// A class to represent an incoming formal argument to a Function. An argument
+/// is a very simple Value. It is essentially a named (optional) type. When used
+/// in the body of a function, it represents the value of the actual argument
+/// the function was called with.
+/// @brief LLVM Argument representation
class Argument : public Value { // Defined in the Function.cpp file
Function *Parent;