[DOC-CVS] [doc-en] master: Document `FFI\CType::getFuncParameterType()` (#3883)

Author: DanielEScherzer (DanielEScherzer)
Committer: GitHub (web-flow)
Pusher: vrana
Date: 2025-04-24T17:01:36+02:00

Commit: https://github.com/php/doc-en/commit/184bc21699133fda630f0327fcd7d636a14d45fb
Raw diff: https://github.com/php/doc-en/commit/184bc21699133fda630f0327fcd7d636a14d45fb.diff

Document `FFI\CType::getFuncParameterType()` (#3883)

Changed paths:
  M  reference/ffi/ctype/getfuncparametertype.xml


Diff:

diff --git a/reference/ffi/ctype/getfuncparametertype.xml b/reference/ffi/ctype/getfuncparametertype.xml
index 3674288a5641..3b5dcf8c7604 100644
--- a/reference/ffi/ctype/getfuncparametertype.xml
+++ b/reference/ffi/ctype/getfuncparametertype.xml
@@ -2,7 +2,7 @@
 <refentry xml:id="ffi-ctype.getfuncparametertype" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>FFI\CType::getFuncParameterType</refname>
-  <refpurpose>Description</refpurpose>
+  <refpurpose>Retrieve the type of a function parameter</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
@@ -12,11 +12,9 @@
    <methodparam><type>int</type><parameter>index</parameter></methodparam>
   </methodsynopsis>
   <para>
-
+   Returns the type of a parameter for the underlying function type.
   </para>
 
-  &warn.undocumented.func;
-
  </refsect1>
 
  <refsect1 role="parameters">
@@ -26,7 +24,7 @@
     <term><parameter>index</parameter></term>
     <listitem>
      <para>
-      
+      Index of the function parameter, zero-based.
      </para>
     </listitem>
    </varlistentry>
@@ -36,7 +34,10 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   
+   Returns the type of a parameter for the underlying function type.
+   If the underlying type is not a function, or the given index is outside
+   of the range of parameters of the function, an
+   <exceptionname>FFI\Exception</exceptionname> is thrown.
   </para>
  </refsect1>