From b0ed4717ea08c61d8a1d0c9205cedff3e33805e3 Mon Sep 17 00:00:00 2001
From: Lars Kanis <lars@greiz-reinsdorf.de>
Date: Sun, 7 May 2023 21:14:36 +0200
Subject: Add documentation to new query methods

of commit e987ab50366a4b08617a20568eabdaa1fb761317
---
 lib/ffi/function.rb | 10 ++++++++++
 1 file changed, 10 insertions(+)

(limited to 'lib/ffi/function.rb')

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
-- 
cgit v1.2.1