From 7251f306b7484db89e9d297774697e0159f8883e Mon Sep 17 00:00:00 2001
From: Hartmut Holzgraefe <hholzgra@php.net>
Date: Sun, 28 Aug 2005 13:16:22 +0000
Subject: [PATCH] API function list included in index.xml, one sample api
 function filled with content

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@194493 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../functions/zend_wrong_param_count.xml      | 26 ++++++++++---------
 internals/zendapi/index.xml                   |  5 +++-
 2 files changed, 18 insertions(+), 13 deletions(-)

diff --git a/internals/zendapi/functions/zend_wrong_param_count.xml b/internals/zendapi/functions/zend_wrong_param_count.xml
index a74ebd258b..b20bacccc8 100644
--- a/internals/zendapi/functions/zend_wrong_param_count.xml
+++ b/internals/zendapi/functions/zend_wrong_param_count.xml
@@ -1,9 +1,9 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <refentry id="zend-api.zend-wrong-param-count">
  <refnamediv>
   <refname>zend_wrong_param_count</refname>
-  <refpurpose>...</refpurpose>
+  <refpurpose>Generate standard error message for wrong parameter count in function or method call</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
@@ -13,7 +13,16 @@
     <methodparam><type></type><parameter>TSRMLS_D</parameter></methodparam>
   </methodsynopsis>
   <para>
-   ...
+   <function>zend_wrong_param_count</function> produces a standard warning message
+   for functions or class methods that have been called with a wrong number of 
+   parameters. The function automaticly puts the right function name and class
+   name (if needed) into the error message.
+  </para>
+  <para>
+   Usually the <function>ZEND_WRONG_PARAM_COUNT</function> and 
+   <function>ZEND_WRONG_PARAM_COUNT_WITH_RETVAL</function> macros 
+   are used to invoke this function instead of calling it immediately
+   as this saves typing the TSRMLS_C argument.
   </para>
  </refsect1>
 
@@ -22,10 +31,10 @@
   <para>
    <variablelist>
     <varlistentry>
-     <term><parameter></parameter></term>
+     <term><parameter>TSRMLS_D</parameter></term>
      <listitem>
       <para>
-       ...
+       Thread context
       </para>
      </listitem>
     </varlistentry>
@@ -33,13 +42,6 @@
   </para>
  </refsect1>
 
- <refsect1 role="returnvalues">
-  &reftitle.returnvalues;
-  <para>
-   ...
-  </para>
- </refsect1>
-
 </refentry>
 
 <!-- Keep this comment at the end of the file
diff --git a/internals/zendapi/index.xml b/internals/zendapi/index.xml
index 021c1df97a..0572a5a150 100644
--- a/internals/zendapi/index.xml
+++ b/internals/zendapi/index.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="ISO-8859-1" ?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
  <chapter id="zend"> 
   <title>&ZendAPI;</title>
   &internals.zendapi.intro;
@@ -22,6 +22,9 @@
   &internals.zendapi.where-to-go;
   &internals.zendapi.configuration-macros;
   &internals.zendapi.api-macros;
+  <sect1><title>API Functions (work in progress)</title>
+  &internals.zendapi.functions;
+  </sect1>
  </chapter> 
  
 <!-- Keep this comment at the end of the file