svn: /phpdoc/doc-base/trunk/RFC/skeletons/ classname.xml method.xml
| From: | Richard Quadling | Date: | Thu, 13 May 2010 15:40:42 +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-6644@lists.php.net to get a copy of this message | ||
rquadling Thu, 13 May 2010 15:40:42 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=299351
Log:
Update skeletons to include OOP, constructor and destructor information.
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-13 15:33:37 UTC (rev 299350)
+++ phpdoc/doc-base/trunk/RFC/skeletons/classname.xml 2010-05-13 15:40:42 UTC (rev 299351)
@@ -63,11 +63,18 @@
-->
<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:methodsynopsis[1])"
/>
+
+<!-- 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
<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[1])"
/>
+ <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'])"
/>
</classsynopsis>
-->
<!-- }}} -->
Modified: phpdoc/doc-base/trunk/RFC/skeletons/method.xml
===================================================================
--- phpdoc/doc-base/trunk/RFC/skeletons/method.xml 2010-05-13 15:33:37 UTC (rev 299350)
+++ phpdoc/doc-base/trunk/RFC/skeletons/method.xml 2010-05-13 15:40:42 UTC (rev 299351)
@@ -24,7 +24,7 @@
<!-- IF OOP & PROCEDURAL
<para>&style.oop;</para>
-->
- <methodsynopsis>
+ <methodsynopsis role="oop">
<!-- Example: All methods have this -->
<type>thereturned
type</type><methodname>ClassName::methodName</methodname>
<!-- Example: Required parameter -->
@@ -45,7 +45,7 @@
Procedural synopsis goes after OOP synopsis.
<para>&style.procedural;</para>
- <methodsynopsis>
+ <methodsynopsis role="procedural">
[Fill in function's parameter details just like in
function.xml/refentry/refsect1[@role=descript]/methodsynopsis]
</methodsynopsis>