[BEAM-12223] Javadoc for JdbcIO is cut off

• Type: Bug
• Status: Resolved
• Priority: P2
• Resolution: Fixed
• Affects Version/s: 2.24.0, 2.25.0, 2.26.0, 2.27.0, 2.28.0
• Fix Version/s: 2.31.0
• Component/s: io-java-jdbc
• Labels: documentation
• Environment: web browser
• Assignee: Alexey Romanenko
• Reporter: Jonathan Rynd
• Created: 26/Apr/21 03:41
• Updated: 10/May/21 08:33
• Resolved: 30/Apr/21 08:55

Description

Looking at the JdbcIO documentation, for instance https://beam.apache.org/releases/javadoc/2.28.0/org/apache/beam/sdk/io/jdbc/JdbcIO.html , we can clearly see that the documentation gets cut off in the middle of a code sample. The rest of the documentation in the javadoc comment is missing; it goes right to the nested class summary. I believe this is because of a blank line that was added to the code for readability purposes; this confuses javadoc.

Issue Links

• links to: GitHub Pull Request #14642