You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@ignite.apache.org by GitBox <gi...@apache.org> on 2021/04/19 10:17:58 UTC
[GitHub] [ignite-3] AMashenkov opened a new pull request #98: IGNITE-14591: Add javadoc validation to checkstyle plugin.
AMashenkov opened a new pull request #98:
URL: https://github.com/apache/ignite-3/pull/98
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [ignite-3] AMashenkov commented on a change in pull request #98: IGNITE-14591: Add javadoc validation to checkstyle plugin.
Posted by GitBox <gi...@apache.org>.
AMashenkov commented on a change in pull request #98:
URL: https://github.com/apache/ignite-3/pull/98#discussion_r639922888
##########
File path: check-rules/checkstyle-javadoc-additional-rules.xml
##########
@@ -0,0 +1,86 @@
+<?xml version="1.0"?>
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<!DOCTYPE module PUBLIC
+ "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
+ "http://checkstyle.org/dtds/configuration_1_3.dtd">
+<module name="Checker">
+ <property name="charset" value="UTF-8"/>
+
+ <property name="fileExtensions" value="java, properties, xml"/>
+
+ <module name="BeforeExecutionExclusionFileFilter">
+ <property name="fileNamePattern" value=".*/(test|internal)/.*"/>
+ </module>
+
+ <!-- SuppressWarning Filter. https://checkstyle.sourceforge.io/config_filters.html#SuppressWarningsFilter -->
+ <module name="SuppressWarningsFilter"/>
+
+ <module name="TreeWalker">
+ <!--
+ Validates Javadoc comments to help ensure they are well formed.
+ See: https://checkstyle.org/config_javadoc.html#JavadocStyle
+ -->
+ <module name="JavadocStyle">
+ <property name="scope" value="public"/>
+ <property name="checkEmptyJavadoc" value="true"/>
+ </module>
+
+ <module name="JavadocStyle">
+ <property name="scope" value="private"/>
+ <property name="excludeScope" value="protected"/>
+ </module>
+
+ <!--
+ Checks for missing Javadoc comments for a method or constructor.
+ See: https://checkstyle.org/config_javadoc.html#MissingJavadocMethod
+ -->
+ <module name="MissingJavadocMethod">
+ <property name="scope" value="protected"/>
+ </module>
+
+ <!--
+ Checks for missing Javadoc comments for class, enum, interface, and annotation interface definitions.
+ See: https://checkstyle.org/config_javadoc.html#MissingJavadocType
+ -->
+ <module name="MissingJavadocType"/>
+
+ <!--
+ Checks that a variable has a Javadoc comment. Ignores serialVersionUID fields.
+ See: https://checkstyle.org/config_javadoc.html#JavadocVariable
+ -->
+ <module name="JavadocVariable">
+ <property name="scope" value="protected"/>
+ </module>
+
+ <!--
+ Checks the Javadoc of a method or constructor.
+ See: https://checkstyle.org/config_javadoc.html#JavadocMethod
+ -->
+ <module name="JavadocMethod">
+ <property name="scope" value="protected"/>
+ <property name="validateThrows" value="true"/>
+ </module>
+
+ <module name="JavadocMethod">
Review comment:
No, there are different rules.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [ignite-3] AMashenkov merged pull request #98: IGNITE-14591: Add javadoc validation to checkstyle plugin.
Posted by GitBox <gi...@apache.org>.
AMashenkov merged pull request #98:
URL: https://github.com/apache/ignite-3/pull/98
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@ignite.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [ignite-3] AMashenkov merged pull request #98: IGNITE-14591: Add javadoc validation to checkstyle plugin.
Posted by GitBox <gi...@apache.org>.
AMashenkov merged pull request #98:
URL: https://github.com/apache/ignite-3/pull/98
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@ignite.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [ignite-3] vveider commented on a change in pull request #98: IGNITE-14591: Add javadoc validation to checkstyle plugin.
Posted by GitBox <gi...@apache.org>.
vveider commented on a change in pull request #98:
URL: https://github.com/apache/ignite-3/pull/98#discussion_r660564246
##########
File path: parent/pom.xml
##########
@@ -596,6 +596,7 @@
<!--
Profile to exclude running surefire (unit) tests but do not prevent running integration ones
-->
+ <!--suppress MavenModelInspection -->
Review comment:
What does explain this comment?
##########
File path: DEVNOTES.md
##########
@@ -28,9 +28,17 @@ Upon build completion, CLI tool can be found be under `modules/cli/target` direc
Code style is checked with [Apache Maven Checkstyle Plugin](https://maven.apache.org/plugins/maven-checkstyle-plugin/).
* [Checkstyle rules](check-rules/checkstyle-rules.xml)
* [Checkstyle suppressions](check-rules/checkstyle-suppressions.xml)
+* [Checkstyle rules for javadocs](https://checkstyle.sourceforge.io/config_javadoc.html)
+
+Run code style checks:
```
mvn clean checkstyle:checkstyle-aggregate
```
+
+Run javadoc style checks for public api:
+```
+mvn clean checkstyle:checkstyle-aggregate -P javadoc
Review comment:
Where is declaration of `javadoc` profile?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@ignite.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [ignite-3] vveider commented on a change in pull request #98: IGNITE-14591: Add javadoc validation to checkstyle plugin.
Posted by GitBox <gi...@apache.org>.
vveider commented on a change in pull request #98:
URL: https://github.com/apache/ignite-3/pull/98#discussion_r660564246
##########
File path: parent/pom.xml
##########
@@ -596,6 +596,7 @@
<!--
Profile to exclude running surefire (unit) tests but do not prevent running integration ones
-->
+ <!--suppress MavenModelInspection -->
Review comment:
What does explain this comment?
##########
File path: DEVNOTES.md
##########
@@ -28,9 +28,17 @@ Upon build completion, CLI tool can be found be under `modules/cli/target` direc
Code style is checked with [Apache Maven Checkstyle Plugin](https://maven.apache.org/plugins/maven-checkstyle-plugin/).
* [Checkstyle rules](check-rules/checkstyle-rules.xml)
* [Checkstyle suppressions](check-rules/checkstyle-suppressions.xml)
+* [Checkstyle rules for javadocs](https://checkstyle.sourceforge.io/config_javadoc.html)
+
+Run code style checks:
```
mvn clean checkstyle:checkstyle-aggregate
```
+
+Run javadoc style checks for public api:
+```
+mvn clean checkstyle:checkstyle-aggregate -P javadoc
Review comment:
Where is declaration of `javadoc` profile?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@ignite.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [ignite-3] ygerzhedovich commented on a change in pull request #98: IGNITE-14591: Add javadoc validation to checkstyle plugin.
Posted by GitBox <gi...@apache.org>.
ygerzhedovich commented on a change in pull request #98:
URL: https://github.com/apache/ignite-3/pull/98#discussion_r639706533
##########
File path: check-rules/checkstyle-javadoc-additional-rules.xml
##########
@@ -0,0 +1,86 @@
+<?xml version="1.0"?>
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<!DOCTYPE module PUBLIC
+ "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
+ "http://checkstyle.org/dtds/configuration_1_3.dtd">
+<module name="Checker">
+ <property name="charset" value="UTF-8"/>
+
+ <property name="fileExtensions" value="java, properties, xml"/>
+
+ <module name="BeforeExecutionExclusionFileFilter">
+ <property name="fileNamePattern" value=".*/(test|internal)/.*"/>
+ </module>
+
+ <!-- SuppressWarning Filter. https://checkstyle.sourceforge.io/config_filters.html#SuppressWarningsFilter -->
+ <module name="SuppressWarningsFilter"/>
+
+ <module name="TreeWalker">
+ <!--
+ Validates Javadoc comments to help ensure they are well formed.
+ See: https://checkstyle.org/config_javadoc.html#JavadocStyle
+ -->
+ <module name="JavadocStyle">
+ <property name="scope" value="public"/>
+ <property name="checkEmptyJavadoc" value="true"/>
+ </module>
+
+ <module name="JavadocStyle">
+ <property name="scope" value="private"/>
+ <property name="excludeScope" value="protected"/>
+ </module>
+
+ <!--
+ Checks for missing Javadoc comments for a method or constructor.
+ See: https://checkstyle.org/config_javadoc.html#MissingJavadocMethod
+ -->
+ <module name="MissingJavadocMethod">
+ <property name="scope" value="protected"/>
+ </module>
+
+ <!--
+ Checks for missing Javadoc comments for class, enum, interface, and annotation interface definitions.
+ See: https://checkstyle.org/config_javadoc.html#MissingJavadocType
+ -->
+ <module name="MissingJavadocType"/>
+
+ <!--
+ Checks that a variable has a Javadoc comment. Ignores serialVersionUID fields.
+ See: https://checkstyle.org/config_javadoc.html#JavadocVariable
+ -->
+ <module name="JavadocVariable">
+ <property name="scope" value="protected"/>
+ </module>
+
+ <!--
+ Checks the Javadoc of a method or constructor.
+ See: https://checkstyle.org/config_javadoc.html#JavadocMethod
+ -->
+ <module name="JavadocMethod">
+ <property name="scope" value="protected"/>
+ <property name="validateThrows" value="true"/>
+ </module>
+
+ <module name="JavadocMethod">
Review comment:
Could you please clarify, the second section will override the first section?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [ignite-3] AMashenkov merged pull request #98: IGNITE-14591: Add javadoc validation to checkstyle plugin.
Posted by GitBox <gi...@apache.org>.
AMashenkov merged pull request #98:
URL: https://github.com/apache/ignite-3/pull/98
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@ignite.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [ignite-3] ygerzhedovich commented on a change in pull request #98: IGNITE-14591: Add javadoc validation to checkstyle plugin.
Posted by GitBox <gi...@apache.org>.
ygerzhedovich commented on a change in pull request #98:
URL: https://github.com/apache/ignite-3/pull/98#discussion_r639703748
##########
File path: check-rules/checkstyle-javadoc-additional-rules.xml
##########
@@ -0,0 +1,86 @@
+<?xml version="1.0"?>
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<!DOCTYPE module PUBLIC
+ "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
+ "http://checkstyle.org/dtds/configuration_1_3.dtd">
+<module name="Checker">
+ <property name="charset" value="UTF-8"/>
+
+ <property name="fileExtensions" value="java, properties, xml"/>
+
+ <module name="BeforeExecutionExclusionFileFilter">
+ <property name="fileNamePattern" value=".*/(test|internal)/.*"/>
+ </module>
+
+ <!-- SuppressWarning Filter. https://checkstyle.sourceforge.io/config_filters.html#SuppressWarningsFilter -->
+ <module name="SuppressWarningsFilter"/>
+
+ <module name="TreeWalker">
+ <!--
+ Validates Javadoc comments to help ensure they are well formed.
+ See: https://checkstyle.org/config_javadoc.html#JavadocStyle
+ -->
+ <module name="JavadocStyle">
+ <property name="scope" value="public"/>
+ <property name="checkEmptyJavadoc" value="true"/>
+ </module>
+
+ <module name="JavadocStyle">
+ <property name="scope" value="private"/>
+ <property name="excludeScope" value="protected"/>
Review comment:
why we should have exclude for protected scope here?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org