Where is Flink's test classes' API documentation (javadoc/scaladoc)

Question

I've noticed, that the Flink's official javadoc lacks the documentation of classes defined in tests. For example, the great ProcessFunctionTestHarnesses mentioned in the official testing guide isn't a part of javadoc.

Browsing the source code on GitHub it's clear, that the test catalogues contain well-documented source code, eg the ProcessFunctionTestHarnesses . But apparently it isn't built or linked anywhere. Or am I missing something?

Answer 1

Only classes that are annotated with annotations that are themselves annotated with @Documented are included in the javadocs. So that means that only classes annotated with

• Experimental
• Internal
• Public
• PublicEvolving
• VisibleForTesting

are included.

The test harnesses are not considered part of Flink's API, and thus are subject to being changed at any time.

BTW, the checkstyle configuration used in the project ensures that all classes have proper javadocs, regardless.