[
https://issues.apache.org/jira/browse/BEAM-12223?focusedWorklogId=589350&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-589350
]
ASF GitHub Bot logged work on BEAM-12223:
-----------------------------------------
Author: ASF GitHub Bot
Created on: 26/Apr/21 17:08
Start Date: 26/Apr/21 17:08
Worklog Time Spent: 10m
Work Description: aromanenko-dev commented on pull request #14642:
URL: https://github.com/apache/beam/pull/14642#issuecomment-827004094
Well, actually it's caused by the fact that `@` in `<pre>{@code } ...</pre>`
is considered as a special character, so it's not properly formatted. I think
the only way to fix it (and to keep `@` character in code snippet) is to use
`<pre></pre>` and escape `@`, `<` and `>` characters with HTML codes.
Btw, you can check JdbcIO Javadoc files locally by running `./gradlew
javadoc` and then opening a file
`sdks/java/io/jdbc/build/docs/javadoc/org/apache/beam/sdk/io/jdbc/JdbcIO.html`
in a browser.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
Issue Time Tracking
-------------------
Worklog Id: (was: 589350)
Time Spent: 50m (was: 40m)
> 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
> Priority: P2
> Labels: documentation
> Time Spent: 50m
> 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)
