cvs: phpdoc /howto working.xml
| From: | Philip Olson | Date: | Tue, 05 Sep 2006 18:28:38 +0000 |
| Subject: | cvs: phpdoc /howto working.xml | ||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969373918@lists.php.net to get a copy of this message | ||
philip Tue Sep 5 18:28:38 2006 UTC
Modified files:
/phpdoc/howto working.xml
Log:
Added the notes, unicode, and errors sections to the function skeleton,
and a few minor edits to it as well.
http://cvs.php.net/viewvc.cgi/phpdoc/howto/working.xml?r1=1.61&r2=1.62&diff_format=u
Index: phpdoc/howto/working.xml
diff -u phpdoc/howto/working.xml:1.61 phpdoc/howto/working.xml:1.62
--- phpdoc/howto/working.xml:1.61 Thu May 11 13:41:36 2006
+++ phpdoc/howto/working.xml Tue Sep 5 18:28:38 2006
@@ -494,7 +494,7 @@
<title>A function skeleton (<filename>func-name.xml</filename>)</title>
<programlisting role="xml">
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.61 $ -->
+<!-- $Revision: 1.62 $ -->
<refentry id="function.func-name">
<refnamediv>
<refname>func_name</refname>
@@ -518,6 +518,7 @@
The functions description goes here.
</para>
</refsect1>
+
<refsect1 role="parameters">
&reftitle.parameters;
<para>
@@ -538,17 +539,10 @@
</para>
</listitem>
</varlistentry>
- <varlistentry>
-
<term><parameter>thirdparameter</parameter></term>
- <listitem>
- <para>
- Its description
- </para>
- </listitem>
- </varlistentry>
</variablelist>
</para>
</refsect1>
+
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
@@ -556,6 +550,21 @@
true on success and false on failure, just use &return.success; here.
</para>
</refsect1>
+
+ <refsect1 role="errors">
+ &reftitle.errors;
+ <para>
+ When does this function issue E_* level errors, or throw exceptions?
+ </para>
+ </refsect1>
+
+ <refsect1 role="unicode">
+ &reftitle.unicode;
+ <para>
+ Unicode information (introduced in PHP 6) goes here.
+ </para>
+ </refsect1>
+
<refsect1 role="changelog">
&reftitle.changelog;
<para>
@@ -569,7 +578,7 @@
</thead>
<tbody>
<row>
- <entry>Write the PHP version here (Ex. 4.3.0)</entry>
+ <entry>Write the PHP version here (Ex. PHP 5.2.0)</entry>
<entry>
Describe the change
</entry>
@@ -585,6 +594,7 @@
</informaltable>
</para>
</refsect1>
+
<refsect1 role="examples">
&reftitle.examples;
<para>
@@ -612,6 +622,16 @@
</example>
</para>
</refsect1>
+
+ <refsect1 role="notes">
+ &reftitle.notes;
+ <para>
+ Any notes that don't fit anywhere else should go here.
+ 90% of the time, notes, warnings or cautions are better placed in the
+ parameters section. Consider that before using this section!
+ </para>
+ </refsect1>
+
<refsect1 role="seealso">
&reftitle.seealso;
<para>
@@ -653,7 +673,7 @@
<title>A <filename>reference.xml</filename> skeleton</title>
<programlisting role="xml">
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.61 $ -->
+<!-- $Revision: 1.62 $ -->
<!-- Purpose: xx -->
<!-- Membership: xx -->
<!-- State: xx -->
@@ -723,7 +743,7 @@
<title>A <filename>configure.xml</filename> skeleton</title>
<programlisting role="xml">
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.61 $ -->
+<!-- $Revision: 1.62 $ -->
<section id="extname.installation">
&reftitle.install;
<para>
@@ -764,7 +784,7 @@
<title>A <filename>constants.xml</filename> skeleton</title>
<programlisting role="xml">
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.61 $ -->
+<!-- $Revision: 1.62 $ -->
<section id="extname.constants">
&reftitle.constants;
&extension.constants;
@@ -814,7 +834,7 @@
<title>A <filename>ini.xml</filename> skeleton</title>
<programlisting role="xml">
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.61 $ -->
+<!-- $Revision: 1.62 $ -->
<section id="extname.configuration">
&reftitle.runtime;
&extension.runtime;