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

danielc Wed, 12 May 2010 00:09:49 +0000 Revision: http://svn.php.net/viewvc?view=revision&revision=299270 Log: Add refname info for items with procedural mapping. Changed paths: U phpdoc/doc-base/trunk/RFC/skeletons/method.xml Modified: phpdoc/doc-base/trunk/RFC/skeletons/method.xml =================================================================== --- phpdoc/doc-base/trunk/RFC/skeletons/method.xml 2010-05-11 23:23:00 UTC (rev 299269) +++ phpdoc/doc-base/trunk/RFC/skeletons/method.xml 2010-05-12 00:09:49 UTC (rev 299270) @@ -3,17 +3,25 @@ <refentry xml:id="classname.methodname" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv> + <!-- If this is a method, use this --> <refname>ClassName::methodName</refname> + <!-- If this is a property, use this instead --> + <refname>ClassName->propertyName</refname> +<!-- IF OOP & PROCEDURAL + +IN GENERAL: If this method also has a procedural mapping, please use the +instructions and code found inside the "IF OOP & PROCEDURAL" comments. + +REFNAME: Procedural refname goes after the OOP refname. + + <refname>function_name</refname> +--> <refpurpose>The methodName purpose</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <!-- IF OOP & PROCEDURAL - -If this method also has a procedural mapping, please use the instructions -and code found inside the "IF OOP & PROCEDURAL" comments. - <para>&style.oop;</para> --> <methodsynopsis> @@ -26,7 +34,7 @@ <!-- Example: If no methodparams exist (void), use this --> <void /> </methodsynopsis> -<!-- If this is an property, not a method, use this instead +<!-- If this is a property, not a method, use this instead <classsynopsis> <ooclass><classname>className</classname></ooclass> <fieldsynopsis><modifier>public</modifier><modifier>static</modifier><type>string</type><varname>name</varname></fieldsynopsis>