@@ -63,7 +63,7 @@ pub enum Predicate {
63
63
LessThan ,
64
64
LessThanOrEqual
65
65
}
66
- /// A function argument.
66
+ /// An argument that is passed to a function .
67
67
pub struct Arg ;
68
68
native_ref ! ( & Arg = LLVMValueRef ) ;
69
69
impl Deref for Arg {
@@ -111,7 +111,7 @@ impl Arg {
111
111
}
112
112
}
113
113
114
- /// A global value (eg: Function, Alias, Global variable)
114
+ /// A value with global scope (eg: Function, Alias, Global variable)
115
115
pub struct GlobalValue ;
116
116
native_ref ! ( & GlobalValue = LLVMValueRef ) ;
117
117
impl Deref for GlobalValue {
@@ -197,7 +197,7 @@ impl GlobalVariable {
197
197
}
198
198
}
199
199
200
- /// An alias to another global
200
+ /// An alias to another global value.
201
201
pub struct Alias ;
202
202
native_ref ! ( & Alias = LLVMValueRef ) ;
203
203
impl Deref for Alias {
@@ -216,7 +216,10 @@ impl CastFrom for Alias {
216
216
}
217
217
}
218
218
219
- /// A function that can be called and contains blocks.
219
+ /// A function is a kind of value that can be called and contains blocks of code.
220
+ ///
221
+ /// To get the value of each argument to a function, you can use the index operator.
222
+ /// For example, `&func[0]` is the value that represents the first argument to the function.
220
223
pub struct Function ;
221
224
native_ref ! ( & Function = LLVMValueRef ) ;
222
225
impl Deref for Function {
@@ -319,7 +322,7 @@ impl GetContext for Function {
319
322
self . get_type ( ) . get_context ( )
320
323
}
321
324
}
322
- /// A way of indicating to LLVM how you want arguments / functions to be handled.
325
+ /// These indicate how you want arguments / functions to be handled.
323
326
#[ derive( Copy , Clone , Eq , PartialEq , Debug ) ]
324
327
#[ repr( C ) ]
325
328
pub enum Attribute {
0 commit comments