dion 02/01/29 18:33:26
Modified: latka/doc developers-guide.xml
Log:
More on coding conventions
Revision Changes Path
1.3 +8 -5 jakarta-commons/latka/doc/developers-guide.xml
Index: developers-guide.xml
===================================================================
RCS file: /home/cvs/jakarta-commons/latka/doc/developers-guide.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- developers-guide.xml 30 Jan 2002 02:27:14 -0000 1.2
+++ developers-guide.xml 30 Jan 2002 02:33:26 -0000 1.3
@@ -4,7 +4,7 @@
<!--
Author: dIon Gillard
- Version: $Id: developers-guide.xml,v 1.2 2002/01/30 02:27:14 dion Exp $
+ Version: $Id: developers-guide.xml,v 1.3 2002/01/30 02:33:26 dion Exp $
-->
<chapter id="users-guide">
@@ -29,12 +29,15 @@
sure what all the conventions are myself, nothing is really authoratative except
the source code</para>
- <para>Onto the conventions... The Sun coding conventions are followed in
most
-places, except for the items that follow</para>
+ <para>Onto the conventions... The Sun coding conventions are followed in
+most places, except for the items that follow</para>
<itemizedlist>
- <listitem><para>private and protected member variables being with an
+ <listitem><para>private and protected member variables begin with an
underscore, <programlisting>_requestSucceeded</programlisting></para></listitem>
- <listitem><para></para></listitem>
+ <listitem><para>private methods also begin with an underscore</para>
+ </listitem>
+ <listitem><para>Javadoc on classes and methods is not yet complete.
+Feel free to help out here :-)</para></listitem>
</itemizedlist>
</section>
</chapter>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
