commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bre...@apache.org
Subject cvs commit: jakarta-commons-sandbox/net/xdocs code-standards.xml
Date Sat, 13 Apr 2002 05:00:51 GMT
brekke      02/04/12 22:00:51

  Modified:    net/xdocs code-standards.xml
  Log:
  Minor update to coding specs wrt java docs.
  
  Revision  Changes    Path
  1.3       +5 -4      jakarta-commons-sandbox/net/xdocs/code-standards.xml
  
  Index: code-standards.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-commons-sandbox/net/xdocs/code-standards.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- code-standards.xml	7 Apr 2002 03:14:54 -0000	1.2
  +++ code-standards.xml	13 Apr 2002 05:00:51 -0000	1.3
  @@ -99,9 +99,10 @@
   </p>
   
   <p>
  -5. JavaDoc <strong>MUST</strong> exist on all methods.  If your code
  -modifications use an existing class/method/variable which lacks
  -JavaDoc, it is required that you add it.  This will improve the
  +5. JavaDoc <strong>MUST</strong> exist on all public and protected methods.
  +JavaDoc on private and default access methods and members is preferred and
  +encouraged.  If your code modifications use an existing class/method/variable 
  +which lacks JavaDoc, it is required that you add it.  This will improve the
   project as a whole.
   </p>
   
  @@ -125,7 +126,7 @@
   </p>
   
   <source><![CDATA[
  -@version $Id: code-standards.xml,v 1.2 2002/04/07 03:14:54 brekke Exp $
  +@version $Id: code-standards.xml,v 1.3 2002/04/13 05:00:51 brekke Exp $
   ]]></source>
   
   <p>
  
  
  

--
To unsubscribe, e-mail:   <mailto:commons-dev-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:commons-dev-help@jakarta.apache.org>


Mime
View raw message