svn: /phpdoc/doc-base/trunk/RFC/skeletons/ function.xml method.xml

From: Date: Thu, 29 Apr 2010 13:35:06 +0000
Subject: svn: /phpdoc/doc-base/trunk/RFC/skeletons/ function.xml method.xml
Groups: php.doc.cvs 
Request: Send a blank email to doc-cvs+get-6529@lists.php.net to get a copy of this message
danielc Thu, 29 Apr 2010 13:35:06 +0000 Revision: http://svn.php.net/viewvc?view=revision&revision=298777 Log: Remove needless paras, per discussion on php-doc. Changed paths: U phpdoc/doc-base/trunk/RFC/skeletons/function.xml U phpdoc/doc-base/trunk/RFC/skeletons/method.xml Modified: phpdoc/doc-base/trunk/RFC/skeletons/function.xml =================================================================== --- phpdoc/doc-base/trunk/RFC/skeletons/function.xml 2010-04-29 13:31:59 UTC (rev 298776) +++ phpdoc/doc-base/trunk/RFC/skeletons/function.xml 2010-04-29 13:35:06 UTC (rev 298777) @@ -26,26 +26,24 @@ <refsect1 role="parameters"><!-- {{{ --> &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>firstparameter</parameter></term> - <listitem> - <para> - Its description - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>secondparameter</parameter></term> - <listitem> - <para> - Its description - </para> - </listitem> - </varlistentry> - </variablelist> - </para> + <variablelist> + <varlistentry> + <term><parameter>firstparameter</parameter></term> + <listitem> + <para> + Its description + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>secondparameter</parameter></term> + <listitem> + <para> + Its description + </para> + </listitem> + </varlistentry> + </variablelist> </refsect1><!-- }}} --> <refsect1 role="returnvalues"><!-- {{{ --> @@ -72,58 +70,54 @@ <refsect1 role="changelog"><!-- {{{ --> &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description;</entry> - </row> - </thead> - <tbody> - <row> - <entry>Enter the version of change here</entry> - <entry> - Describe the change - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>Enter the version of change here</entry> + <entry> + Describe the change + </entry> + </row> + </tbody> + </tgroup> + </informaltable> </refsect1><!-- }}} --> <refsect1 role="examples"><!-- {{{ --> &reftitle.examples; - <para> - <example xml:id="function-name.example.basic"><!-- {{{ --> - <title><function>function-name</function> example</title> - <para> - Any text that describes the purpose of the example, or what - goes on in the example should be here. (Inside the <example> tag, not out). - </para> - <programlisting role="php"> + <example xml:id="function-name.example.basic"><!-- {{{ --> + <title><function>function-name</function> example</title> + <para> + Any text that describes the purpose of the example, or what + goes on in the example should be here. (Inside the <example> tag, not out). + </para> + <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { - echo 'Use the PEAR Coding standards'; + echo 'Use the PEAR Coding standards'; } if ($thereisoutput === 'and it is multiple lines') { - echo 'Use a screen like we did below'; + echo 'Use a screen like we did below'; } ?> ]]> - </programlisting> - &example.outputs.similar; - <screen> + </programlisting> + &example.outputs.similar; + <screen> <![CDATA[ Use the PEAR Coding standards Use a screen like we did below ]]> - </screen> - </example><!-- }}} --> - </para> + </screen> + </example><!-- }}} --> </refsect1><!-- }}} --> <refsect1 role="notes"><!-- {{{ --> @@ -142,13 +136,11 @@ <refsect1 role="seealso"><!-- {{{ --> &reftitle.seealso; - <para> - <simplelist> - <member><function>somefunc</function></member> - <member><function>another_func</function></member> - <member>The <link linkend="something">something appendix</link></member> - </simplelist> - </para> + <simplelist> + <member><function>somefunc</function></member> + <member><function>another_func</function></member> + <member>The <link linkend="something">something appendix</link></member> + </simplelist> </refsect1><!-- }}} --> </refentry> Modified: phpdoc/doc-base/trunk/RFC/skeletons/method.xml =================================================================== --- phpdoc/doc-base/trunk/RFC/skeletons/method.xml 2010-04-29 13:31:59 UTC (rev 298776) +++ phpdoc/doc-base/trunk/RFC/skeletons/method.xml 2010-04-29 13:35:06 UTC (rev 298777) @@ -39,26 +39,24 @@ <refsect1 role="parameters"> &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>firstparameter</parameter></term> - <listitem> - <para> - Its description - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>secondparameter</parameter></term> - <listitem> - <para> - Its description - </para> - </listitem> - </varlistentry> - </variablelist> - </para> + <variablelist> + <varlistentry> + <term><parameter>firstparameter</parameter></term> + <listitem> + <para> + Its description + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>secondparameter</parameter></term> + <listitem> + <para> + Its description + </para> + </listitem> + </varlistentry> + </variablelist> </refsect1> <refsect1 role="returnvalues"> @@ -85,38 +83,35 @@ <refsect1 role="changelog"> &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description;</entry> - </row> - </thead> - <tbody> - <row> - <entry>Enter the version of change here</entry> - <entry> - Describe the change - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>Enter the version of change here</entry> + <entry> + Describe the change + </entry> + </row> + </tbody> + </tgroup> + </informaltable> </refsect1> <refsect1 role="examples"> &reftitle.examples; - <para> - <example xml:id="classname.methodname.example.basic"> - <title><function>ClassName::methodName</function> example</title> - <para> - Any text that describes the purpose of the example, or what - goes on in the example should be here. (Inside the <example> tag, not out). - </para> - <programlisting role="php"> + <example xml:id="classname.methodname.example.basic"> + <title><function>ClassName::methodName</function> example</title> + <para> + Any text that describes the purpose of the example, or what + goes on in the example should be here. (Inside the <example> tag, not out). + </para> + <programlisting role="php"> <![CDATA[ <?php if ($anexample === true) { @@ -127,16 +122,15 @@ } ?> ]]> - </programlisting> - &example.outputs.similar; - <screen> + </programlisting> + &example.outputs.similar; + <screen> <![CDATA[ Use the PEAR Coding standards Use a screen like we did below ]]> - </screen> - </example> - </para> + </screen> + </example> </refsect1> <refsect1 role="notes"> @@ -155,14 +149,13 @@ <refsect1 role="seealso"> &reftitle.seealso; - <para> - <simplelist> - <member><function>somefunc</function></member> - <member><function>another_func</function></member> - <member>The <link linkend="something">something appendix</link></member> - </simplelist> - </para> + <simplelist> + <member><function>somefunc</function></member> + <member><function>another_func</function></member> + <member>The <link linkend="something">something appendix</link></member> + </simplelist> </refsect1> + </refentry> <!-- Keep this comment at the end of the file

« previous php.doc.cvs (#6529) next »