[
https://issues.apache.org/jira/browse/BEAM-12223?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Alexey Romanenko updated BEAM-12223:
------------------------------------
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
|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. (was: Looking at the JdbcIO documentation, for instance
[https://beam.apache.org/releases/javadoc/2.28.0/org/apache/beam/sdk/io/jdbc/JdbcIO.html
|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.)
> Javadoc for JdbcIO is cut off
> -----------------------------
>
> Key: BEAM-12223
> URL: https://issues.apache.org/jira/browse/BEAM-12223
> Project: Beam
> Issue Type: Bug
> Components: examples-java, io-java-jdbc
> Affects Versions: 2.24.0, 2.25.0, 2.26.0, 2.27.0, 2.28.0
> Environment: web browser
> Reporter: Jonathan Rynd
> Priority: P2
> Labels: documentation
> Time Spent: 40m
> Remaining Estimate: 0h
>
> Looking at the JdbcIO documentation, for instance
> [https://beam.apache.org/releases/javadoc/2.28.0/org/apache/beam/sdk/io/jdbc/JdbcIO.html
>
> |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.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
