cameronlee314 commented on a change in pull request #1394:
URL: https://github.com/apache/samza/pull/1394#discussion_r445775869
##########
File path: checkstyle/checkstyle-suppressions.xml
##########
@@ -25,7 +25,10 @@
<suppress checks="ConstantName"
files="ApplicationStatus.java"
lines="26-29"/>
+ <!-- don't require FQDNs to be used in API javadocs -->
<suppress id="preventJavadocUnusedImports"
files=".*samza-api.*"/>
+ <!-- don't require FQDNs to be used in descriptor javadocs -->
+ <suppress
files="samza-kafka/src/main/java/org/apache/samza/system/kafka/descriptors"
id="preventJavadocUnusedImports" />
Review comment:
In the descriptor classes, the javadocs may include references to some
other classes which aren't directly used in the code (e.g. through `{@link
<className>}`). For API classes like descriptors, it is nice to be able to just
use the simple class name (e.g. `{@link MyClass}`) instead of the full
qualified name (e.g. `{@link org.apache.samza.MyClass}`).
I will clarify the the comment.
----------------------------------------------------------------
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:
[email protected]
