rwaldhoff 02/04/23 10:47:17 Modified: latka/src/docbook developers-guide.xml Log: update to coding conventions comments Revision Changes Path 1.2 +12 -18 jakarta-commons/latka/src/docbook/developers-guide.xml Index: developers-guide.xml =================================================================== RCS file: /home/cvs/jakarta-commons/latka/src/docbook/developers-guide.xml,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- developers-guide.xml 22 Apr 2002 15:48:33 -0000 1.1 +++ developers-guide.xml 23 Apr 2002 17:47:17 -0000 1.2 @@ -4,7 +4,7 @@ <!-- Author: dIon Gillard - Version: $Id: developers-guide.xml,v 1.1 2002/04/22 15:48:33 dion Exp $ + Version: $Id: developers-guide.xml,v 1.2 2002/04/23 17:47:17 rwaldhoff Exp $ --> <chapter id="users-guide"> @@ -19,23 +19,17 @@ </section> <section id="coding-style"> <title>Coding Style</title> - - <para>Latka has some unusual coding conventions, which we've hopefully -captured using a tool, <ulink url="http://checkstyle.sourceforge.net">CheckStyle -</ulink>.</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 begin with an -underscore, <programlisting>_requestSucceeded</programlisting></para></listitem> - <listitem><para>private methods also begin with an underscore on -rare occasions (mainly when there is some public method and protected/private -method with an otherwise identical signature)</para> - </listitem> - <listitem><para>Javadoc on classes and methods is not yet complete. -Feel free to help out here :-)</para></listitem> - </itemizedlist> + <para> + Like most Jakarta projects, the Latka code base essentially follows the + Sun/K&R style with one major exception: private and protected member + variables begin with an underscore, for example, + <programlisting>boolean _requestSucceeded;</programlisting> + instead of + <programlisting>boolean requestSucceeded;</programlisting>. + </para> + <para> + Javadoc on classes and methods is not yet complete. Feel free to help out here :-) + </para> </section> <section id="general-practices">
-- To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]> For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>