Skip to content

Commit 7109545

Browse files
committed
Add some documentation
1 parent 0741b13 commit 7109545

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

Sources/LLVM/Function+Attributes.swift

+6
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,13 @@ public enum AttributeIndex: ExpressibleByIntegerLiteral, RawRepresentable {
222222
}
223223

224224
/// An LLVM attribute.
225+
///
226+
/// Functions, return types and each parameter may have a set of attributes
227+
/// associated with them. Such attributes are used to communicate additional
228+
/// information about a function. Attributes are considered to be part of the
229+
/// function, but not of the function type.
225230
public protocol Attribute {
231+
/// Retrieves the underlying LLVM attribute reference object.
226232
func asLLVM() -> LLVMAttributeRef
227233
}
228234

0 commit comments

Comments
 (0)