Callback prototypes
| From: | Justin Martin | Date: | Fri, 03 Feb 2012 00:49:49 +0000 |
| Subject: | Callback prototypes | ||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969383606@lists.php.net to get a copy of this message | ||
Hello everyone,
I'd like to propose using the methodsynopsis format for callback prototypes, on function references such as that for array_reduce.
<varlistentry>
<term><parameter>function</parameter></term>
<listitem>
<para>
The callback function.
</para>
<methodsynopsis>
<type>void</type><methodname>callback</methodname>
<methodparam><type>array</type><parameter role="reference">result</parameter></methodparam>
<methodparam><type>mixed</type><parameter>item</parameter></methodparam>
</methodsynopsis>
</listitem>
</varlistentry>
This is rendered as such in the current styling of the online documentation: http://i.imgur.com/cUAPt.png
Any objections? If we decide upon this format, I'd also go ahead and update any existing documentation on functions that use callbacks.
Thanks,
Justin Martin