commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From pascalschumac...@apache.org
Subject [2/6] [lang] Apply JavaDoc checkstyle only to public methods
Date Sun, 12 Mar 2017 16:58:08 GMT
Apply JavaDoc checkstyle only to public methods

The defacto style of the project requires Javadoc for public methods
only, but the checkstyle Javadoc check defaults to requiring them even
for private methods, generating 46 errors.

This patch sets the checkstyle Javadoc check's scope to public to clean
up the checkstyle report so it can be enabled in the CI.

If we wish to reset the check to a laxer scope, the aforementioned
errors should be fixed first.


Project: http://git-wip-us.apache.org/repos/asf/commons-lang/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-lang/commit/1f8479a8
Tree: http://git-wip-us.apache.org/repos/asf/commons-lang/tree/1f8479a8
Diff: http://git-wip-us.apache.org/repos/asf/commons-lang/diff/1f8479a8

Branch: refs/heads/master
Commit: 1f8479a84b52bb8c755c84501ba98f0d511adfd0
Parents: 4282efa
Author: Allon Mureinik <amureini@redhat.com>
Authored: Sun Mar 5 12:05:23 2017 +0200
Committer: pascalschumacher <pascalschumacher@gmx.net>
Committed: Sun Mar 12 17:41:49 2017 +0100

----------------------------------------------------------------------
 checkstyle.xml | 1 +
 1 file changed, 1 insertion(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/commons-lang/blob/1f8479a8/checkstyle.xml
----------------------------------------------------------------------
diff --git a/checkstyle.xml b/checkstyle.xml
index d4df9da..bbec654 100644
--- a/checkstyle.xml
+++ b/checkstyle.xml
@@ -41,6 +41,7 @@ limitations under the License.
     </module>
     <module name="JavadocMethod">
       <property name="allowUndeclaredRTE" value="true"/>
+      <property name="scope" value="public" />
     </module>
     <module name="UpperEll" />
  </module>


Mime
View raw message