mirror of https://github.com/apache/kafka.git
eb7f490159
Make sure no scaladoc warnings are emitted from the streams-scala project build. We cannot fully fix all scaladoc warnings due to limitations of the scaladoc tool, so this is a best-effort attempt at fixing as many warnings as possible. We also disable one problematic class of scaladoc wornings (link errors) in the gradle build. The causes of existing warnings are that we link to java members from scaladoc, which is not possible, or we fail to disambiguate some members. The broad rule applied in the changes is - For links to Java members such as [[StateStore]], we use the fully qualified name in a code tag to make manual link resolution via a search engine easy. - For some common terms that are also linked to Java members, like [[Serde]], we omit the link. - We disambiguate where possible. - In the special case of @throws declarations with Java Exceptions, we do not seem to be able to avoid the warning altogther. Reviewers: Matthias J. Sax <mjsax@apache.org>, Guozhang Wang <wangguoz@gmail.com> |
||
|---|---|---|
| .. | ||
| src | ||
| .gitignore | ||