[jira] [Commented] (BEAM-12223) Javadoc for JdbcIO is cut off

["Alexey Romanenko (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/BEAM-12223?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17337195#comment-17337195 ] 

Alexey Romanenko commented on BEAM-12223:
-----------------------------------------

If "<pre>\{@code ... \}" contains any characters that have to be escaped (like, "@", "<" and ">"). In this case, one of the option is to escape them with "\{@literal ... \}" and then we need to switch to "<pre><code>...</pre></code>".

> Javadoc for JdbcIO is cut off
> -----------------------------
>
>                 Key: BEAM-12223
>                 URL: https://issues.apache.org/jira/browse/BEAM-12223
>             Project: Beam
>          Issue Type: Bug
>          Components: 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
>            Assignee: Alexey Romanenko
>            Priority: P2
>              Labels: documentation
>             Fix For: 2.31.0
>
>          Time Spent: 2h
>  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)