summaryrefslogtreecommitdiff
path: root/lib/ffi/function.rb
diff options
context:
space:
mode:
authorLars Kanis <lars@greiz-reinsdorf.de>2023-05-07 21:14:36 +0200
committerLars Kanis <lars@greiz-reinsdorf.de>2023-05-07 21:14:36 +0200
commitb0ed4717ea08c61d8a1d0c9205cedff3e33805e3 (patch)
tree5eb0dfcc21a382e805bc8fc85020df479ef32ad0 /lib/ffi/function.rb
parentfe556f176d8239887fb583db2f3bb78f92a8cec2 (diff)
downloadffi-b0ed4717ea08c61d8a1d0c9205cedff3e33805e3.tar.gz
Add documentation to new query methods
of commit e987ab50366a4b08617a20568eabdaa1fb761317
Diffstat (limited to 'lib/ffi/function.rb')
-rw-r--r--lib/ffi/function.rb10
1 files changed, 10 insertions, 0 deletions
diff --git a/lib/ffi/function.rb b/lib/ffi/function.rb
index 6fff6ae..b4469be 100644
--- a/lib/ffi/function.rb
+++ b/lib/ffi/function.rb
@@ -32,10 +32,20 @@ module FFI
class Function
# Only MRI allows function type queries
if private_method_defined?(:type)
+ # Retrieve the return type of the function
+ #
+ # This method returns FFI type returned by the function.
+ #
+ # @return [FFI::Type]
def return_type
type.return_type
end
+ # Retrieve Array of parameter types
+ #
+ # This method returns an Array of FFI types accepted as function parameters.
+ #
+ # @return [Array<FFI::Type>]
def param_types
type.param_types
end