cvs: peardoc /en/authoring/package/categorie/mypackage/myclass myfunction.xml
| From: | Daniel Convissor | Date: | Mon, 19 Apr 2004 04:39:01 +0000 |
| Subject: | cvs: peardoc /en/authoring/package/categorie/mypackage/myclass myfunction.xml | ||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-3631@lists.php.net to get a copy of this message | ||
danielc Mon Apr 19 00:39:01 2004 EDT
Modified files:
/peardoc/en/authoring/package/categorie/mypackage/myclass
myfunction.xml
Log:
Provide hints for writing good refpurpose values.
http://cvs.php.net/diff.php/peardoc/en/authoring/package/categorie/mypackage/myclass/myfunction.xml?r1=1.20&r2=1.21&ty=u
Index: peardoc/en/authoring/package/categorie/mypackage/myclass/myfunction.xml
diff -u peardoc/en/authoring/package/categorie/mypackage/myclass/myfunction.xml:1.20
peardoc/en/authoring/package/categorie/mypackage/myclass/myfunction.xml:1.21
--- peardoc/en/authoring/package/categorie/mypackage/myclass/myfunction.xml:1.20 Fri Apr 16 16:40:53
2004
+++ peardoc/en/authoring/package/categorie/mypackage/myclass/myfunction.xml Mon Apr 19 00:39:00 2004
@@ -1,10 +1,16 @@
<?xml version="1.0" encoding="iso-8859-1" ?>
-<!-- $Revision: 1.20 $ -->
+<!-- $Revision: 1.21 $ -->
<refentry id="package.categorie.mypackage.myclass.myfunction">
<refnamediv>
<refname>My_Class::myFunction()</refname>
- <refpurpose>a sample function</refpurpose>
+ <refpurpose>Outputs short description of function</refpurpose>
+ <!--
+ The refpurpose should use 3rd person declarative
+ rather than 2nd person imperative.
+ Gets the label (preferred)
+ Get the label (avoid)
+ -->
</refnamediv>
<refsynopsisdiv>