hbase-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "nkeywal (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (HBASE-7512) Document the findbugs library annotation
Date Tue, 08 Jan 2013 08:50:12 GMT

    [ https://issues.apache.org/jira/browse/HBASE-7512?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13546708#comment-13546708

nkeywal commented on HBASE-7512:

I would propose this:

--------------------- Javadoc
This is also a very common feedback item. Don't forget Javadoc! 
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. Findbugs
Findbugs is used to detect common bugs pattern. As Javadoc, it is checked during precommit,
and as Javadoc, please fix them.
You can run findbugs locally with 'mvn findbugs:findbugs': it will generate the findbugs files
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:

    justification="I know what I'm doing")

Note that we're using the apache licensed version of the annotations.

> Document the findbugs library annotation
> ----------------------------------------
>                 Key: HBASE-7512
>                 URL: https://issues.apache.org/jira/browse/HBASE-7512
>             Project: HBase
>          Issue Type: Improvement
>          Components: documentation
>    Affects Versions: 0.96.0
>            Reporter: nkeywal
>            Assignee: nkeywal
>            Priority: Minor
>             Fix For: 0.96.0
> See HBASE-7508

This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

View raw message