commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From d...@apache.org
Subject cvs commit: jakarta-commons/docs/latka developers-guide.html
Date Wed, 30 Jan 2002 03:13:55 GMT
dion        02/01/29 19:13:55

  Added:       docs/latka developers-guide.html
  Log:
  Initial checkin
  
  Revision  Changes    Path
  1.1                  jakarta-commons/docs/latka/developers-guide.html
  
  Index: developers-guide.html
  ===================================================================
  <html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Latka
- Latka Developers's Guide</title><meta value="
                      Commons Documentation Team
                  " name="author"><meta value="commons-dev@jakarta.apache.org" name="email"></head><body
vlink="#525D76" alink="#525D76" link="#525D76" text="#000000" bgcolor="#ffffff"><table
cellspacing="4" width="100%" border="0"><!--PAGE HEADER--><tr><td colspan="2"><!--JAKARTA
LOGO--><a href="http://jakarta.apache.org/"><img border="0" alt="The Jakarta Project"
align="left" src="http://jakarta.apache.org/images/jakarta-logo.gif"></a></td></tr><!--HEADER
SEPARATOR--><tr><td colspan="2"><hr size="1" noshade=""></td></tr><tr><!--LEFT
SIDE NAVIGATION--><td nowrap="true" valign="top" width="20%"><p><strong>Home</strong></p><ul><li><a
href="./index.html">Latka</a></li><li><a href="http://jakarta.apache.org/commons/index.html">Jakarta
Commons</a></li><li><a href="http://jakarta.apache.org/">Jakarta</a></li></ul><p><strong>Documentation</strong></p><ul><li><a
href="./users-guide.html">User's Guide</a></li><li><a href="./xml-reference.html">XML
Reference</a></li><li><a href="./api/index.html">API Docs</a></li><li><a
href="./developers-guide.html">Developers Guide</a></li></ul><p><strong>Download</strong></p><ul><li><a
href="http://jakarta.apache.org/builds/jakarta-commons/release/commons-latka/1.0/">Latest
Release</a></li><li><a href="http://jakarta.apache.org/builds/jakarta-commons/nightly/commons-latka/">Nightly
Build</a></li></ul><p><strong>Project Files</strong></p><ul><li><a
href="./status.html">Status</a></li><li><a href="http://cvs.apache.org/viewcvs/jakarta-commons/latka/">CVS</a></li><li><a
href="./proposal.html">Original Proposal</a></li><li><a href="http://jakarta.apache.org/commons/license.html">License</a></li></ul><p><strong>Jakarta
Community</strong></p><ul><li><a href="http://jakarta.apache.org/site/getinvolved.html">Get
Involved</a></li><li><a href="http://jakarta.apache.org/site/mail.html">Mailing
Lists</a></li><li><a href="http://jakarta.apache.org/site/cvsindex.html">CVS
Repositories</a></li><li><a href="http://jakarta.apache.org/site/library.html">Reference
Library</a></li><li><a href="http://jakarta.apache.org/site/bugs.html">Bugs</a></li></ul></td><!--RIGHT
SIDE MAIN BODY--><td align="left" valign="top" width="80%"><table width="100%"
cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font
face="arial,helvetica.sanserif" color="#ffffff"><a name="Introduction"><strong>Introduction</strong></a></font></td></tr><tr><td><blockquote>
          
          <p>These are informal notes gathered as I've started working
  on <a href="index.html">Latka</a>. Hopefully they will make sense to
  those coming after me, and possibly clarify the current state for the existing
          </p>
          <p>This should probably be set out (from the source side) more
  like a book than a chapter</p>
          <p>That said, on with the disorganised discourse</p>
      </blockquote></td></tr></table><table width="100%" cellpadding="2"
cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif"
color="#ffffff"><a name="Coding Style"><strong>Coding Style</strong></a></font></td></tr><tr><td><blockquote>
          
          
          <p>Latka has some unusual coding conventions, which I'm trying to
  capture at the moment using a tool, <a href="http://checkstyle.sourceforge.net">CheckStyle</a>.
Since I'm not quite
  sure what all the conventions are myself, nothing is really authoratative except
  the source code</p>
  
          <p>Onto the conventions... The Sun coding conventions are followed in
  most places, except for the items that follow</p>
          <ul>
              <li><p>private and protected member variables begin with an 
  underscore, <div align="left"><table border="0" cellpadding="0" cellspacing="4"><tr><td
height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1"
width="1" src="/images/void.gif"></td><td height="1" bgcolor="#023264"><img
border="0" hspace="0" vspace="0" height="1" width="1" src="/images/void.gif"></td><td
height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1"
width="1" src="/images/void.gif"></td></tr><tr><td width="1" bgcolor="#023264"><img
border="0" hspace="0" vspace="0" height="1" width="1" src="/images/void.gif"></td><td
height="1" bgcolor="#ffffff"><pre>_requestSucceeded</pre></td><td
width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1"
src="/images/void.gif"></td></tr><tr><td height="1" width="1" bgcolor="#023264"><img
border="0" hspace="0" vspace="0" height="1" width="1" src="/images/void.gif"></td><td
height="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1"
src="/images/void.gif"></td><td height="1" width="1" bgcolor="#023264"><img
border="0" hspace="0" vspace="0" height="1" width="1" src="/images/void.gif"></td></tr></table></div></p></li>
              <li><p>private methods also begin with an underscore</p>
              </li>
              <li><p>Javadoc on classes and methods is not yet complete.
  Feel free to help out here :-)</p></li>
          </ul>
      </blockquote></td></tr></table><table width="100%" cellpadding="2"
cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif"
color="#ffffff"><a name="General Practices"><strong>General Practices</strong></a></font></td></tr><tr><td><blockquote>
          
          
          <p>Here are some of the development practices of the Latka team</p>
          
          <ul>
              <li><p>Before committing any changes, run a cvs diff to
  ensure unexpected changes are not being introduced</p>
              </li>
              <li><p>Before committing java source code changes, do a
  clean build of the project to ensure all code still compiles. Run all testcases
  to ensure the code isn't broken. Run the checkstyle task to ensure code meets
  the project's current standards</p>
              </li>
              <li><p>Before committing changes to the web pages, do a
  clean build of the webpages target in the main build file and view the resulting
  output</p></li>
          </ul>
      </blockquote></td></tr></table></td></tr><!--FOOTER
SEPARATOR--><tr><td colspan="2"><hr size="1" noshade=""></td></tr><!--PAGE
FOOTER--><tr><td colspan="2"><div align="center"><font size="-1" color="#525D76"><em>
          Copyright &copy; 1999-2002, Apache Software Foundation
          </em></font></div></td></tr></table></body></html>
  
  

--
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