From 3daeedc13971e5f06f4c4be1d91e5bd2abfe7ea8 Mon Sep 17 00:00:00 2001
From: Jakub Vrana <vrana@php.net>
Date: Wed, 19 Sep 2007 12:11:52 +0000
Subject: [PATCH] Document openssl_pkey_get_details()

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@242699 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../openssl/functions/openssl-pkey-free.xml   |  3 +-
 .../functions/openssl-pkey-get-details.xml    | 38 +++++++++++++++++--
 2 files changed, 37 insertions(+), 4 deletions(-)

diff --git a/reference/openssl/functions/openssl-pkey-free.xml b/reference/openssl/functions/openssl-pkey-free.xml
index f3199e1432..74f8a4db6f 100644
--- a/reference/openssl/functions/openssl-pkey-free.xml
+++ b/reference/openssl/functions/openssl-pkey-free.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
 <refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.openssl-pkey-free">
  <refnamediv>
   <refname>openssl_pkey_free</refname>
@@ -26,6 +26,7 @@
      <term><parameter>key</parameter></term>
      <listitem>
       <para>
+       Resource holding the key.
       </para>
      </listitem>
     </varlistentry>
diff --git a/reference/openssl/functions/openssl-pkey-get-details.xml b/reference/openssl/functions/openssl-pkey-get-details.xml
index cc9da5549a..7967b76e66 100644
--- a/reference/openssl/functions/openssl-pkey-get-details.xml
+++ b/reference/openssl/functions/openssl-pkey-get-details.xml
@@ -1,9 +1,9 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
 <refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.openssl-pkey-get-details">
  <refnamediv>
   <refname>openssl_pkey_get_details</refname>
-  <refpurpose>Returns an array with the key details (bits, pkey, type)</refpurpose>
+  <refpurpose>Returns an array with the key details</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
@@ -12,7 +12,39 @@
    <type>array</type><methodname>openssl_pkey_get_details</methodname>
    <methodparam><type>resource</type><parameter>key</parameter></methodparam>
   </methodsynopsis>
-  &warn.undocumented.func;
+  <para>
+   This function returns the key details (bits, key, type).
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>key</parameter></term>
+     <listitem>
+      <para>
+       Resource holding the key.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns an array with the key details in success or &false; in failure.
+   Returned array has indexes <literal>bits</literal> (number of bits),
+   <literal>key</literal> (string representation of the public key) and
+   <literal>type</literal> (type of the key which is one of
+   <constant>OPENSSL_KEYTYPE_RSA</constant>,
+   <constant>OPENSSL_KEYTYPE_DSA</constant>,
+   <constant>OPENSSL_KEYTYPE_DH</constant>,
+   <constant>OPENSSL_KEYTYPE_EC</constant> or -1 meaning unknown).
+  </para>
  </refsect1>
 
 </refentry>