Apache
/
commons-lang
mirror of https://github.com/apache/commons-lang.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add section on deprecations in javadoc 

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/lang/trunk@137593 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Stephen Colebourne 2003-08-14 00:21:23 +00:00
parent 9c6e4b0421
commit 24bf34b652
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
DEVELOPERS-GUIDE.html
View File

@ -8,7 +8,7 @@
<div align="center">
<h1>The Jakarta Commons <em>Lang</em> Package</h1>
<h2>Developers Guide</h2>
$Id: DEVELOPERS-GUIDE.html,v 1.5 2003/08/14 00:08:14 bayard Exp $<br />
$Id: DEVELOPERS-GUIDE.html,v 1.6 2003/08/14 00:21:23 scolebourne Exp $<br />
<a href="#Introduction">[Introduction]</a>
<a href="#PackageStructure">[Package Structure]</a>
<a href="#UtilityClasses">[Utility Classes]</a>
@ -102,12 +102,19 @@ to small!) to enhance readability of the generated Javadoc.</p>
It should be supported with an explanation within a normal paragraph.</p>
<h4>Exception throwing</h4>
<p>When throwing an exception to indicate a bad argument, always throw
<p>When throwing an exception to indicate a bad argument, always try to throw
IllegalArgumentException, even if the argument was null. Do not throw
NullPointerException. </p>
NullPointerException. (Obviously, you should document what the code actually does!)</p>
<h4>Deprecations</h4>
<p>When deprecating a method or class include a clear reference to when the method will be deleted.
This should be of the form 'Method will be removed in Commons Lang 3.0.'.
<h4>Language used in code/comments</h4>
<p>It has been decided to casually standardize on US-English. To avoid misplaced jeers of 'americanisation', the people making this decision largely write in non-US-English. However, it's not something to get worked up about. Lots of spelling differences will creep in all over. </p>
<p>It has been decided to casually standardize on US-English.
To avoid misplaced jeers of 'americanisation', the people making this decision largely write in non-US-English.
However, it's not something to get worked up about.
Lots of spelling differences will creep in all over.</p>
</body>
</html>