| Hartmut Holzgraefe 2005-08-28, 6:55 pm |
| hholzgra Sun Aug 28 09:16:23 2005 EDT
Modified files:
/phpdoc/en/internals/zendapi index.xml
/phpdoc/en/internals/zendapi/functions zend_wrong_param_count.xml
Log:
API function list included in index.xml,
one sample api function filled with content
http://cvs.php.net/diff.php/phpdoc/...1.1&r2=1.2&ty=u
Index: phpdoc/en/internals/zendapi/index.xml
diff -u phpdoc/en/internals/zendapi/index.xml:1.1 phpdoc/en/internals/zendapi/index.xml:1.2
--- phpdoc/en/internals/zendapi/index.xml:1.1 Sun Aug 21 12:27:06 2005
+++ phpdoc/en/internals/zendapi/index.xml Sun Aug 28 09:16:22 2005
@@ -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
http://cvs.php.net/diff.php/phpdoc/...1.1&r2=1.2&ty=u
Index: phpdoc/en/internals/zendapi/functions/zend_wrong_param_count.xml
diff -u phpdoc/en/internals/zendapi/functions/zend_wrong_param_count.xml:1.1 phpdoc/en/internals/zendapi/functions/zend_wrong_param_count.xml:1.2
--- phpdoc/en/internals/zendapi/functions/zend_wrong_param_count.xml:1.1 Sun Aug 28 05:58:51 2005
+++ phpdoc/en/internals/zendapi/functions/zend_wrong_param_count.xml Sun Aug 28 09:16:22 2005
@@ -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
|