Apache
/
hbase
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

HBASE-7512 Document the findbugs library annotation 

git-svn-id: https://svn.apache.org/repos/asf/hbase/trunk@1431910 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Michael Stack 2013-01-11 06:45:18 +00:00
parent 50bac9f397
commit 6b97306c1e
1 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
src/docbkx/developer.xml
View File

@ -1059,6 +1059,12 @@ Bar bar = foo.getBar(); <--- imagine there's an extra space(s) after the
</section> </section>
<section xml:id="common.patch.feedback.writable"> <section xml:id="common.patch.feedback.writable">
<title>Implementing Writable</title> <title>Implementing Writable</title>
<note>
<title>Applies pre-0.96 only</title>
<para>In 0.96, HBase moved to protobufs. The below section on Writables
applies to 0.94.x and previous, not to 0.96 and beyond.
</para>
</note>
<para>Every class returned by RegionServers must implement <code>Writable</code>. If you <para>Every class returned by RegionServers must implement <code>Writable</code>. If you
are creating a new class that needs to implement this interface, don't forget the default constructor. are creating a new class that needs to implement this interface, don't forget the default constructor.
</para> </para>
@ -1066,8 +1072,29 @@ Bar bar = foo.getBar(); &lt;--- imagine there's an extra space(s) after the
<section xml:id="common.patch.feedback.javadoc"> <section xml:id="common.patch.feedback.javadoc">
<title>Javadoc</title> <title>Javadoc</title>
<para>This is also a very common feedback item. Don't forget Javadoc! <para>This is also a very common feedback item. Don't forget Javadoc!
<para>Javadoc warnings are checked during precommit. If the precommit tool gives you a '-1',
please fix the javadoc issue. Your patch won't be committed if it adds such warnings.
</para>
</para> </para>
</section> </section>
<section xml:id="common.patch.feedback.findbugs">
<title>Findbugs</title>
<para>
Findbugs is used to detect common bugs pattern. As Javadoc, it is checked during
the precommit build up on Apache's Jenkins, and as with Javadoc, please fix them.
You can run findbugs locally with 'mvn findbugs:findbugs': it will generate the
findbugs files locally. Sometimes, you may have to write code smarter than
Findbugs. You can annotate your code to tell Findbugs you know what you're
doing, by annotating your class with:
<programlisting>@edu.umd.cs.findbugs.annotations.SuppressWarnings(
value="HE_EQUALS_USE_HASHCODE",
justification="I know what I'm doing")</programlisting>
</para>
<para>
Note that we're using the apache licensed version of the annotations.
</para>
</section>
<section xml:id="common.patch.feedback.javadoc.defaults"> <section xml:id="common.patch.feedback.javadoc.defaults">
<title>Javadoc - Useless Defaults</title> <title>Javadoc - Useless Defaults</title>
<para>Don't just leave the @param arguments the way your IDE generated them. Don't do this... <para>Don't just leave the @param arguments the way your IDE generated them. Don't do this...