From a57ec08be20eff6949afce8315ed12352ceae1a4 Mon Sep 17 00:00:00 2001
From: Hartmut Holzgraefe <hholzgra@php.net>
Date: Sat, 14 Jan 2006 13:13:23 +0000
Subject: [PATCH] created a seperate directory for Zend API macros

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@205222 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../ZEND_WRONG_PARAM_COUNT_WITH_RETVAL.xml    | 54 +++++++++++++++++++
 .../{functions => macros}/Z_ARRVAL.xml        |  0
 .../{functions => macros}/Z_ARRVAL_P.xml      |  0
 .../{functions => macros}/Z_ARRVAL_PP.xml     |  0
 .../zendapi/{functions => macros}/Z_BVAL.xml  |  0
 .../{functions => macros}/Z_BVAL_P.xml        |  0
 .../{functions => macros}/Z_BVAL_PP.xml       |  0
 .../zendapi/{functions => macros}/Z_DVAL.xml  |  0
 .../{functions => macros}/Z_DVAL_P.xml        |  0
 .../{functions => macros}/Z_DVAL_PP.xml       |  0
 .../zendapi/{functions => macros}/Z_LVAL.xml  |  0
 .../{functions => macros}/Z_LVAL_P.xml        |  0
 .../{functions => macros}/Z_LVAL_PP.xml       |  0
 .../zendapi/{functions => macros}/Z_OBJCE.xml |  0
 .../{functions => macros}/Z_OBJCE_P.xml       |  0
 .../{functions => macros}/Z_OBJCE_PP.xml      |  0
 .../{functions => macros}/Z_OBJPROP.xml       |  0
 .../{functions => macros}/Z_OBJPROP_P.xml     |  0
 .../{functions => macros}/Z_OBJPROP_PP.xml    |  0
 .../Z_OBJ_CLASS_NAME_P.xml                    |  0
 .../{functions => macros}/Z_OBJ_HANDLE.xml    |  0
 .../{functions => macros}/Z_OBJ_HANDLER.xml   |  0
 .../{functions => macros}/Z_OBJ_HANDLER_P.xml |  0
 .../Z_OBJ_HANDLER_PP.xml                      |  0
 .../{functions => macros}/Z_OBJ_HANDLE_P.xml  |  0
 .../{functions => macros}/Z_OBJ_HANDLE_PP.xml |  0
 .../{functions => macros}/Z_OBJ_HT.xml        |  0
 .../{functions => macros}/Z_OBJ_HT_P.xml      |  0
 .../{functions => macros}/Z_OBJ_HT_PP.xml     |  0
 .../{functions => macros}/Z_RESVAL.xml        |  0
 .../{functions => macros}/Z_RESVAL_P.xml      |  0
 .../{functions => macros}/Z_RESVAL_PP.xml     |  0
 .../{functions => macros}/Z_STRLEN.xml        |  0
 .../{functions => macros}/Z_STRLEN_P.xml      |  0
 .../{functions => macros}/Z_STRLEN_PP.xml     |  0
 .../{functions => macros}/Z_STRVAL.xml        |  0
 .../{functions => macros}/Z_STRVAL_P.xml      |  0
 .../{functions => macros}/Z_STRVAL_PP.xml     |  0
 .../zendapi/{functions => macros}/Z_TYPE.xml  |  0
 .../{functions => macros}/Z_TYPE_P.xml        |  0
 .../{functions => macros}/Z_TYPE_PP.xml       |  0
 41 files changed, 54 insertions(+)
 create mode 100644 internals/zendapi/macros/ZEND_WRONG_PARAM_COUNT_WITH_RETVAL.xml
 rename internals/zendapi/{functions => macros}/Z_ARRVAL.xml (100%)
 rename internals/zendapi/{functions => macros}/Z_ARRVAL_P.xml (100%)
 rename internals/zendapi/{functions => macros}/Z_ARRVAL_PP.xml (100%)
 rename internals/zendapi/{functions => macros}/Z_BVAL.xml (100%)
 rename internals/zendapi/{functions => macros}/Z_BVAL_P.xml (100%)
 rename internals/zendapi/{functions => macros}/Z_BVAL_PP.xml (100%)
 rename internals/zendapi/{functions => macros}/Z_DVAL.xml (100%)
 rename internals/zendapi/{functions => macros}/Z_DVAL_P.xml (100%)
 rename internals/zendapi/{functions => macros}/Z_DVAL_PP.xml (100%)
 rename internals/zendapi/{functions => macros}/Z_LVAL.xml (100%)
 rename internals/zendapi/{functions => macros}/Z_LVAL_P.xml (100%)
 rename internals/zendapi/{functions => macros}/Z_LVAL_PP.xml (100%)
 rename internals/zendapi/{functions => macros}/Z_OBJCE.xml (100%)
 rename internals/zendapi/{functions => macros}/Z_OBJCE_P.xml (100%)
 rename internals/zendapi/{functions => macros}/Z_OBJCE_PP.xml (100%)
 rename internals/zendapi/{functions => macros}/Z_OBJPROP.xml (100%)
 rename internals/zendapi/{functions => macros}/Z_OBJPROP_P.xml (100%)
 rename internals/zendapi/{functions => macros}/Z_OBJPROP_PP.xml (100%)
 rename internals/zendapi/{functions => macros}/Z_OBJ_CLASS_NAME_P.xml (100%)
 rename internals/zendapi/{functions => macros}/Z_OBJ_HANDLE.xml (100%)
 rename internals/zendapi/{functions => macros}/Z_OBJ_HANDLER.xml (100%)
 rename internals/zendapi/{functions => macros}/Z_OBJ_HANDLER_P.xml (100%)
 rename internals/zendapi/{functions => macros}/Z_OBJ_HANDLER_PP.xml (100%)
 rename internals/zendapi/{functions => macros}/Z_OBJ_HANDLE_P.xml (100%)
 rename internals/zendapi/{functions => macros}/Z_OBJ_HANDLE_PP.xml (100%)
 rename internals/zendapi/{functions => macros}/Z_OBJ_HT.xml (100%)
 rename internals/zendapi/{functions => macros}/Z_OBJ_HT_P.xml (100%)
 rename internals/zendapi/{functions => macros}/Z_OBJ_HT_PP.xml (100%)
 rename internals/zendapi/{functions => macros}/Z_RESVAL.xml (100%)
 rename internals/zendapi/{functions => macros}/Z_RESVAL_P.xml (100%)
 rename internals/zendapi/{functions => macros}/Z_RESVAL_PP.xml (100%)
 rename internals/zendapi/{functions => macros}/Z_STRLEN.xml (100%)
 rename internals/zendapi/{functions => macros}/Z_STRLEN_P.xml (100%)
 rename internals/zendapi/{functions => macros}/Z_STRLEN_PP.xml (100%)
 rename internals/zendapi/{functions => macros}/Z_STRVAL.xml (100%)
 rename internals/zendapi/{functions => macros}/Z_STRVAL_P.xml (100%)
 rename internals/zendapi/{functions => macros}/Z_STRVAL_PP.xml (100%)
 rename internals/zendapi/{functions => macros}/Z_TYPE.xml (100%)
 rename internals/zendapi/{functions => macros}/Z_TYPE_P.xml (100%)
 rename internals/zendapi/{functions => macros}/Z_TYPE_PP.xml (100%)

diff --git a/internals/zendapi/macros/ZEND_WRONG_PARAM_COUNT_WITH_RETVAL.xml b/internals/zendapi/macros/ZEND_WRONG_PARAM_COUNT_WITH_RETVAL.xml
new file mode 100644
index 0000000000..6d5c84269f
--- /dev/null
+++ b/internals/zendapi/macros/ZEND_WRONG_PARAM_COUNT_WITH_RETVAL.xml
@@ -0,0 +1,54 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.1 $ -->
+<refentry id="zend-api-macro.ZEND-WRONG-PARAM-COUNT-WITH-RETVAL">
+ <refnamediv>
+  <refname>ZEND_WRONG_PARAM_COUNT_WITH_RETVAL</refname>
+  <refpurpose>Generate standard error message and return custom value</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <literallayout>#include &lt;zend_API.h&gt;</literallayout>
+  <methodsynopsis>
+   <type>void</type><methodname>ZEND_WRONG_PARAM_COUNT_WITH_RETVAL</methodname>
+   <methodparam><type>mixed</type><parameter>return_value</parameter></methodparam>
+  </methodsynopsis>
+  <note><simpara>This macro is part of the API but not used in any bundled or PECL extension</simpara></note>
+  <para>
+   <function>ZEND_WRONG_PARAM_COUNT_WITH_RETVAL</function> produces a standard warning message
+   for functions or class methods that have been called with a wrong number of 
+   parameters and returns its parameter to the calling function. 
+   The macro automaticly puts the right function name and class
+   name (if needed) into the error message.
+  </para>
+  <para>
+   The <parameter>return_value</parameter> parameter is returned to the calling
+   function of the current one.
+  </para>
+  <para>
+   <function>ZEND_WRONG_PARAM_COUNT_WITH_RETVAL</function> is actually a convenience
+   wrapper for <function>zend_wrong_param_count</function>.
+  </para>
+ </refsect1>
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"../../../../manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/internals/zendapi/functions/Z_ARRVAL.xml b/internals/zendapi/macros/Z_ARRVAL.xml
similarity index 100%
rename from internals/zendapi/functions/Z_ARRVAL.xml
rename to internals/zendapi/macros/Z_ARRVAL.xml
diff --git a/internals/zendapi/functions/Z_ARRVAL_P.xml b/internals/zendapi/macros/Z_ARRVAL_P.xml
similarity index 100%
rename from internals/zendapi/functions/Z_ARRVAL_P.xml
rename to internals/zendapi/macros/Z_ARRVAL_P.xml
diff --git a/internals/zendapi/functions/Z_ARRVAL_PP.xml b/internals/zendapi/macros/Z_ARRVAL_PP.xml
similarity index 100%
rename from internals/zendapi/functions/Z_ARRVAL_PP.xml
rename to internals/zendapi/macros/Z_ARRVAL_PP.xml
diff --git a/internals/zendapi/functions/Z_BVAL.xml b/internals/zendapi/macros/Z_BVAL.xml
similarity index 100%
rename from internals/zendapi/functions/Z_BVAL.xml
rename to internals/zendapi/macros/Z_BVAL.xml
diff --git a/internals/zendapi/functions/Z_BVAL_P.xml b/internals/zendapi/macros/Z_BVAL_P.xml
similarity index 100%
rename from internals/zendapi/functions/Z_BVAL_P.xml
rename to internals/zendapi/macros/Z_BVAL_P.xml
diff --git a/internals/zendapi/functions/Z_BVAL_PP.xml b/internals/zendapi/macros/Z_BVAL_PP.xml
similarity index 100%
rename from internals/zendapi/functions/Z_BVAL_PP.xml
rename to internals/zendapi/macros/Z_BVAL_PP.xml
diff --git a/internals/zendapi/functions/Z_DVAL.xml b/internals/zendapi/macros/Z_DVAL.xml
similarity index 100%
rename from internals/zendapi/functions/Z_DVAL.xml
rename to internals/zendapi/macros/Z_DVAL.xml
diff --git a/internals/zendapi/functions/Z_DVAL_P.xml b/internals/zendapi/macros/Z_DVAL_P.xml
similarity index 100%
rename from internals/zendapi/functions/Z_DVAL_P.xml
rename to internals/zendapi/macros/Z_DVAL_P.xml
diff --git a/internals/zendapi/functions/Z_DVAL_PP.xml b/internals/zendapi/macros/Z_DVAL_PP.xml
similarity index 100%
rename from internals/zendapi/functions/Z_DVAL_PP.xml
rename to internals/zendapi/macros/Z_DVAL_PP.xml
diff --git a/internals/zendapi/functions/Z_LVAL.xml b/internals/zendapi/macros/Z_LVAL.xml
similarity index 100%
rename from internals/zendapi/functions/Z_LVAL.xml
rename to internals/zendapi/macros/Z_LVAL.xml
diff --git a/internals/zendapi/functions/Z_LVAL_P.xml b/internals/zendapi/macros/Z_LVAL_P.xml
similarity index 100%
rename from internals/zendapi/functions/Z_LVAL_P.xml
rename to internals/zendapi/macros/Z_LVAL_P.xml
diff --git a/internals/zendapi/functions/Z_LVAL_PP.xml b/internals/zendapi/macros/Z_LVAL_PP.xml
similarity index 100%
rename from internals/zendapi/functions/Z_LVAL_PP.xml
rename to internals/zendapi/macros/Z_LVAL_PP.xml
diff --git a/internals/zendapi/functions/Z_OBJCE.xml b/internals/zendapi/macros/Z_OBJCE.xml
similarity index 100%
rename from internals/zendapi/functions/Z_OBJCE.xml
rename to internals/zendapi/macros/Z_OBJCE.xml
diff --git a/internals/zendapi/functions/Z_OBJCE_P.xml b/internals/zendapi/macros/Z_OBJCE_P.xml
similarity index 100%
rename from internals/zendapi/functions/Z_OBJCE_P.xml
rename to internals/zendapi/macros/Z_OBJCE_P.xml
diff --git a/internals/zendapi/functions/Z_OBJCE_PP.xml b/internals/zendapi/macros/Z_OBJCE_PP.xml
similarity index 100%
rename from internals/zendapi/functions/Z_OBJCE_PP.xml
rename to internals/zendapi/macros/Z_OBJCE_PP.xml
diff --git a/internals/zendapi/functions/Z_OBJPROP.xml b/internals/zendapi/macros/Z_OBJPROP.xml
similarity index 100%
rename from internals/zendapi/functions/Z_OBJPROP.xml
rename to internals/zendapi/macros/Z_OBJPROP.xml
diff --git a/internals/zendapi/functions/Z_OBJPROP_P.xml b/internals/zendapi/macros/Z_OBJPROP_P.xml
similarity index 100%
rename from internals/zendapi/functions/Z_OBJPROP_P.xml
rename to internals/zendapi/macros/Z_OBJPROP_P.xml
diff --git a/internals/zendapi/functions/Z_OBJPROP_PP.xml b/internals/zendapi/macros/Z_OBJPROP_PP.xml
similarity index 100%
rename from internals/zendapi/functions/Z_OBJPROP_PP.xml
rename to internals/zendapi/macros/Z_OBJPROP_PP.xml
diff --git a/internals/zendapi/functions/Z_OBJ_CLASS_NAME_P.xml b/internals/zendapi/macros/Z_OBJ_CLASS_NAME_P.xml
similarity index 100%
rename from internals/zendapi/functions/Z_OBJ_CLASS_NAME_P.xml
rename to internals/zendapi/macros/Z_OBJ_CLASS_NAME_P.xml
diff --git a/internals/zendapi/functions/Z_OBJ_HANDLE.xml b/internals/zendapi/macros/Z_OBJ_HANDLE.xml
similarity index 100%
rename from internals/zendapi/functions/Z_OBJ_HANDLE.xml
rename to internals/zendapi/macros/Z_OBJ_HANDLE.xml
diff --git a/internals/zendapi/functions/Z_OBJ_HANDLER.xml b/internals/zendapi/macros/Z_OBJ_HANDLER.xml
similarity index 100%
rename from internals/zendapi/functions/Z_OBJ_HANDLER.xml
rename to internals/zendapi/macros/Z_OBJ_HANDLER.xml
diff --git a/internals/zendapi/functions/Z_OBJ_HANDLER_P.xml b/internals/zendapi/macros/Z_OBJ_HANDLER_P.xml
similarity index 100%
rename from internals/zendapi/functions/Z_OBJ_HANDLER_P.xml
rename to internals/zendapi/macros/Z_OBJ_HANDLER_P.xml
diff --git a/internals/zendapi/functions/Z_OBJ_HANDLER_PP.xml b/internals/zendapi/macros/Z_OBJ_HANDLER_PP.xml
similarity index 100%
rename from internals/zendapi/functions/Z_OBJ_HANDLER_PP.xml
rename to internals/zendapi/macros/Z_OBJ_HANDLER_PP.xml
diff --git a/internals/zendapi/functions/Z_OBJ_HANDLE_P.xml b/internals/zendapi/macros/Z_OBJ_HANDLE_P.xml
similarity index 100%
rename from internals/zendapi/functions/Z_OBJ_HANDLE_P.xml
rename to internals/zendapi/macros/Z_OBJ_HANDLE_P.xml
diff --git a/internals/zendapi/functions/Z_OBJ_HANDLE_PP.xml b/internals/zendapi/macros/Z_OBJ_HANDLE_PP.xml
similarity index 100%
rename from internals/zendapi/functions/Z_OBJ_HANDLE_PP.xml
rename to internals/zendapi/macros/Z_OBJ_HANDLE_PP.xml
diff --git a/internals/zendapi/functions/Z_OBJ_HT.xml b/internals/zendapi/macros/Z_OBJ_HT.xml
similarity index 100%
rename from internals/zendapi/functions/Z_OBJ_HT.xml
rename to internals/zendapi/macros/Z_OBJ_HT.xml
diff --git a/internals/zendapi/functions/Z_OBJ_HT_P.xml b/internals/zendapi/macros/Z_OBJ_HT_P.xml
similarity index 100%
rename from internals/zendapi/functions/Z_OBJ_HT_P.xml
rename to internals/zendapi/macros/Z_OBJ_HT_P.xml
diff --git a/internals/zendapi/functions/Z_OBJ_HT_PP.xml b/internals/zendapi/macros/Z_OBJ_HT_PP.xml
similarity index 100%
rename from internals/zendapi/functions/Z_OBJ_HT_PP.xml
rename to internals/zendapi/macros/Z_OBJ_HT_PP.xml
diff --git a/internals/zendapi/functions/Z_RESVAL.xml b/internals/zendapi/macros/Z_RESVAL.xml
similarity index 100%
rename from internals/zendapi/functions/Z_RESVAL.xml
rename to internals/zendapi/macros/Z_RESVAL.xml
diff --git a/internals/zendapi/functions/Z_RESVAL_P.xml b/internals/zendapi/macros/Z_RESVAL_P.xml
similarity index 100%
rename from internals/zendapi/functions/Z_RESVAL_P.xml
rename to internals/zendapi/macros/Z_RESVAL_P.xml
diff --git a/internals/zendapi/functions/Z_RESVAL_PP.xml b/internals/zendapi/macros/Z_RESVAL_PP.xml
similarity index 100%
rename from internals/zendapi/functions/Z_RESVAL_PP.xml
rename to internals/zendapi/macros/Z_RESVAL_PP.xml
diff --git a/internals/zendapi/functions/Z_STRLEN.xml b/internals/zendapi/macros/Z_STRLEN.xml
similarity index 100%
rename from internals/zendapi/functions/Z_STRLEN.xml
rename to internals/zendapi/macros/Z_STRLEN.xml
diff --git a/internals/zendapi/functions/Z_STRLEN_P.xml b/internals/zendapi/macros/Z_STRLEN_P.xml
similarity index 100%
rename from internals/zendapi/functions/Z_STRLEN_P.xml
rename to internals/zendapi/macros/Z_STRLEN_P.xml
diff --git a/internals/zendapi/functions/Z_STRLEN_PP.xml b/internals/zendapi/macros/Z_STRLEN_PP.xml
similarity index 100%
rename from internals/zendapi/functions/Z_STRLEN_PP.xml
rename to internals/zendapi/macros/Z_STRLEN_PP.xml
diff --git a/internals/zendapi/functions/Z_STRVAL.xml b/internals/zendapi/macros/Z_STRVAL.xml
similarity index 100%
rename from internals/zendapi/functions/Z_STRVAL.xml
rename to internals/zendapi/macros/Z_STRVAL.xml
diff --git a/internals/zendapi/functions/Z_STRVAL_P.xml b/internals/zendapi/macros/Z_STRVAL_P.xml
similarity index 100%
rename from internals/zendapi/functions/Z_STRVAL_P.xml
rename to internals/zendapi/macros/Z_STRVAL_P.xml
diff --git a/internals/zendapi/functions/Z_STRVAL_PP.xml b/internals/zendapi/macros/Z_STRVAL_PP.xml
similarity index 100%
rename from internals/zendapi/functions/Z_STRVAL_PP.xml
rename to internals/zendapi/macros/Z_STRVAL_PP.xml
diff --git a/internals/zendapi/functions/Z_TYPE.xml b/internals/zendapi/macros/Z_TYPE.xml
similarity index 100%
rename from internals/zendapi/functions/Z_TYPE.xml
rename to internals/zendapi/macros/Z_TYPE.xml
diff --git a/internals/zendapi/functions/Z_TYPE_P.xml b/internals/zendapi/macros/Z_TYPE_P.xml
similarity index 100%
rename from internals/zendapi/functions/Z_TYPE_P.xml
rename to internals/zendapi/macros/Z_TYPE_P.xml
diff --git a/internals/zendapi/functions/Z_TYPE_PP.xml b/internals/zendapi/macros/Z_TYPE_PP.xml
similarity index 100%
rename from internals/zendapi/functions/Z_TYPE_PP.xml
rename to internals/zendapi/macros/Z_TYPE_PP.xml