svn: /phpdoc/doc-base/trunk/RFC/skeletons/ classname.xml method.xml
| From: | Richard Quadling | Date: | Tue, 18 May 2010 16:56:49 +0000 |
| Subject: | svn: /phpdoc/doc-base/trunk/RFC/skeletons/ classname.xml method.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-6675@lists.php.net to get a copy of this message | ||
rquadling Tue, 18 May 2010 16:56:49 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=299459
Log:
Update skeletons to use the complete constructor/destructor/method synopsis tags (with fallbacks to
handle the lack of con/des/meth).
Changed paths:
U phpdoc/doc-base/trunk/RFC/skeletons/classname.xml
U phpdoc/doc-base/trunk/RFC/skeletons/method.xml
Modified: phpdoc/doc-base/trunk/RFC/skeletons/classname.xml
===================================================================
--- phpdoc/doc-base/trunk/RFC/skeletons/classname.xml 2010-05-18 16:52:10 UTC (rev 299458)
+++ phpdoc/doc-base/trunk/RFC/skeletons/classname.xml 2010-05-18 16:56:49 UTC (rev 299459)
@@ -59,22 +59,24 @@
-->
<!-- If properties are documented "as a method", use this
- <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook)
xpointer(id('class.classname')/db:refentry/db:refsect1[@role='description']/descendant::db:fieldsynopsis[1])"
/>
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook)
xpointer(id('class.classname')/db:refentry/db:refsect1[@role='description']/descendant::db:fieldsynopsis)"
/>
-->
-
- <classsynopsisinfo role="comment">Methods</classsynopsisinfo>
-<!-- If there is a constructor, use this
- <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook)
xpointer(id('class.classname')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[@role='oop'])"
/>
--->
-<!-- If there is a destructor, use this
- <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook)
xpointer(id('class.classname')/db:refentry/db:refsect1[@role='description']/descendant::db:destructorsynopsis[@role='oop'])"
/>
--->
- <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook)
xpointer(id('class.classname')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='oop'])"
/>
-
-<!-- If the class extends a class use this
+<!-- Edit the classname below -->
+ <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook)
xpointer(id('class.classname')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])">
+ <xi:fallback />
+ </xi:include>
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook)
xpointer(id('class.classname')/db:refentry/db:refsect1[@role='description']/descendant::db:destructorsynopsis[not(@role='procedural')])">
+ <xi:fallback />
+ </xi:include>
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook)
xpointer(id('class.classname')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])">
+ <xi:fallback />
+ </xi:include>
+
+<!-- If the class extends a class use this. Repeat the <xi:include> tag for all the parent
classes in the event of multiple extensions; i.e. class XYZ extends class XY and class XY extends
class X
<classsynopsisinfo role="comment">Inherited methods</classsynopsisinfo>
- <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook)
xpointer(id('class.baseclassname')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='oop'])"
/>
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook)
xpointer(id('class.baseclassname')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')
and not(modifier='private')])" />
</classsynopsis>
-->
<!-- }}} -->
Modified: phpdoc/doc-base/trunk/RFC/skeletons/method.xml
===================================================================
--- phpdoc/doc-base/trunk/RFC/skeletons/method.xml 2010-05-18 16:52:10 UTC (rev 299458)
+++ phpdoc/doc-base/trunk/RFC/skeletons/method.xml 2010-05-18 16:56:49 UTC (rev 299459)
@@ -21,11 +21,13 @@
<refsect1 role="description">
&reftitle.description;
-<!-- IF OOP & PROCEDURAL
+<!-- IF OOP & PROCEDURAL.
<para>&style.oop;</para>
-->
+<!-- Use constructorsynopsis and destructorsynopsis rather than methodsynopsis for __construct
and __destruct
+ There is no return <type> for the constructorsynopsis/destructorsynopsis -->
<methodsynopsis role="oop">
- <!-- Example: All methods have this -->
+ <!-- Example: All methods have this. Don't use <void> for the return type, use
<type>void</type> instead. -->
<type>thereturned
type</type><methodname>ClassName::methodName</methodname>
<!-- Example: Required parameter -->
<methodparam><type>param1type</type><parameter>firstparameter</parameter></methodparam>
@@ -47,7 +49,7 @@
<para>&style.procedural;</para>
<methodsynopsis role="procedural">
[Fill in function's parameter details just like in
- function.xml/refentry/refsect1[@role=descript]/methodsynopsis]
+ function.xml/refentry/refsect1[@role=description]/methodsynopsis]
</methodsynopsis>
-->
<para>