[jira] [Commented] (HDFS-13943) [JDK10] Fix javadoc errors in hadoop-hdfs-client module

[Takanobu Asanuma (JIRA)]

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

Takanobu Asanuma commented on HDFS-13943:
-----------------------------------------

Thanks for working on this, [~ajisakaa]! Some comments

*ClientProtocol:*
 It would be better to format the paragraphs more.
{noformat}
<p><b>Configuration parameters</b></p>
...
<p><b>Special cases</b></p>
{noformat}
*ClientProtocol, DFSUtilClient:*
 For the generics in the javadoc, It would be better to use the escape 
codes(&lt; and &gt;) instead of deleting them.

*StripedBlockUtil:*
 IIUC, the ascii arts are for developers who are reading source codes directly. 
So I suggest we leave them as they are. How about using just comments (/* ... 
*/) instead of javadoc (/** ... */ )?

> [JDK10] Fix javadoc errors in hadoop-hdfs-client module
> -------------------------------------------------------
>
>                 Key: HDFS-13943
>                 URL: https://issues.apache.org/jira/browse/HDFS-13943
>             Project: Hadoop HDFS
>          Issue Type: Sub-task
>          Components: documentation
>            Reporter: Akira Ajisaka
>            Assignee: Akira Ajisaka
>            Priority: Major
>         Attachments: HDFS-13943.01.patch
>
>
> There are 85 errors in hadoop-hdfs-client module.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

---------------------------------------------------------------------
To unsubscribe, e-mail: hdfs-issues-unsubscr...@hadoop.apache.org
For additional commands, e-mail: hdfs-issues-h...@hadoop.apache.org