Add descriptions for SensitiveParameterValue

see php#2162 see php#2163
TimWolla · Jan 10, 2023 · 8720844 · 8720844
1 parent a51dc10
commit 8720844
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 12 deletions.
diff --git a/language/predefined/sensitiveparametervalue.xml b/language/predefined/sensitiveparametervalue.xml
@@ -9,7 +9,13 @@
   <section xml:id="sensitiveparametervalue.intro">
    &reftitle.intro;
    <para>
-
+    The <classname>SensitiveParameterValue</classname> class allows wrapping sensitive
+    values to protect them against accidental exposure.
+   </para>
+   <para>
+    Values of parameters having the <classname>SensitiveParameter</classname> attribute
+    will automatically be wrapped inside of a <classname>SensitiveParameterValue</classname>
+    object within stack traces.
    </para>
   </section>
 <!-- }}} -->
@@ -58,7 +64,7 @@
      <term><varname>value</varname></term>
      <listitem>
       <para>
-
+       The sensitive value to be protected against accidental exposure.
       </para>
      </listitem>
     </varlistentry>

diff --git a/language/predefined/sensitiveparametervalue/construct.xml b/language/predefined/sensitiveparametervalue/construct.xml
@@ -2,7 +2,7 @@
 <refentry xml:id="sensitiveparametervalue.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>SensitiveParameterValue::__construct</refname>
-  <refpurpose>Description</refpurpose>
+  <refpurpose>Constructs a new SensitiveParameterValue object</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
@@ -26,7 +26,7 @@
     <term><parameter>value</parameter></term>
     <listitem>
      <para>
-
+      An arbitrary value that should be stored inside the <classname>SensitiveParameterValue</classname> object.
      </para>
     </listitem>
    </varlistentry>

diff --git a/language/predefined/sensitiveparametervalue/debuginfo.xml b/language/predefined/sensitiveparametervalue/debuginfo.xml
@@ -2,7 +2,7 @@
 <refentry xml:id="sensitiveparametervalue.debuginfo" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>SensitiveParameterValue::__debugInfo</refname>
-  <refpurpose>Description</refpurpose>
+  <refpurpose>Protects the sensitive value against accidental exposure</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
@@ -12,11 +12,8 @@
    <void/>
   </methodsynopsis>
   <para>
-
+   Returns an empty &array; to protect the sensitive value against accidental exposure when using <function>var_dump</function>.
   </para>
-
-  &warn.undocumented.func;
-
  </refsect1>
 
  <refsect1 role="parameters">
@@ -27,7 +24,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-
+   An empty &array;.
   </para>
  </refsect1>
 

diff --git a/language/predefined/sensitiveparametervalue/getvalue.xml b/language/predefined/sensitiveparametervalue/getvalue.xml
@@ -2,7 +2,7 @@
 <refentry xml:id="sensitiveparametervalue.getvalue" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>SensitiveParameterValue::getValue</refname>
-  <refpurpose>Description</refpurpose>
+  <refpurpose>Returns the sensitive value</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
@@ -27,7 +27,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-
+   The sensitive value.
   </para>
  </refsect1>