GitHub user prateekm opened a pull request:
https://github.com/apache/samza/pull/760
Javadoc cleanup for new Application, Descriptor, Context and Table APIs -
Part 2
Currently, we don't allow imports for use only in javadocs. This requires
using FQNs in link tags, which is not very readable. Checkstyle's UnusedImport
rule has an option to allow imports for use in javadoc comments
(processJavadocs=true, should be read as "check javadocs for import usage ==
true").
AFAICT, there's no good way to change the check's properties within a
submodule. This PR adds both versions (strict and relaxed) to the checkstyle,
and disables the strict validation for samza-api only.
This PR also updates the javadocs to use the class names with imports.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/prateekm/samza javadoc-cleanup
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/samza/pull/760.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #760
----
commit 97d7308f637705f7a45905fc62fb50b836214736
Author: Prateek Maheshwari <pmaheshwari@...>
Date: 2018-10-24T17:35:51Z
Javadoc cleanup for new Application, Descriptor, Context and Table APIs.
----
---
