[DOC-CVS] [doc-en] master: xhprof_disable() can return null (fix #4620)

Author: Jakub Vrana (vrana)
Date: 2025-04-19T00:04:37+02:00

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

xhprof_disable() can return null (fix #4620)

Changed paths:
  M  reference/xhprof/functions/xhprof-disable.xml
  M  reference/xhprof/functions/xhprof-sample-disable.xml


Diff:

diff --git a/reference/xhprof/functions/xhprof-disable.xml b/reference/xhprof/functions/xhprof-disable.xml
index 9242db659804..527c71fe0594 100644
--- a/reference/xhprof/functions/xhprof-disable.xml
+++ b/reference/xhprof/functions/xhprof-disable.xml
@@ -10,7 +10,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <type>array</type><methodname>xhprof_disable</methodname>
+   <type class="union"><type>array</type><type>null</type></type><methodname>xhprof_disable</methodname>
    <void />
   </methodsynopsis>
   <para>
@@ -27,6 +27,7 @@
   &reftitle.returnvalues;
   <para>
    An <type>array</type> of xhprof data, from the run.
+   Returns &null; if profiling is not enabled.
   </para>
  </refsect1>
 
diff --git a/reference/xhprof/functions/xhprof-sample-disable.xml b/reference/xhprof/functions/xhprof-sample-disable.xml
index a134360a9d75..f3de431883dd 100644
--- a/reference/xhprof/functions/xhprof-sample-disable.xml
+++ b/reference/xhprof/functions/xhprof-sample-disable.xml
@@ -10,11 +10,11 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <type>array</type><methodname>xhprof_sample_disable</methodname>
+   <type class="union"><type>array</type><type>null</type></type><methodname>xhprof_sample_disable</methodname>
    <void />
   </methodsynopsis>
   <para>
-   Stops the sample mode xhprof profiler, and 
+   Stops the sample mode xhprof profiler, and returns the profile info.
   </para>
 
  </refsect1>
@@ -28,6 +28,7 @@
   &reftitle.returnvalues;
   <para>
    An <type>array</type> of xhprof sample data, from the run.
+   Returns &null; if profiling is not enabled.
   </para>
  </refsect1>