[jira] [Commented] (HBASE-17766) Generate Javadoc for hbase-spark module

["Yi Liang (JIRA)" <ji...@apache.org>]

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

Yi Liang commented on HBASE-17766:
----------------------------------

I also investigate the project Apache Flink, which also have java&scala mixed code,  and they also use this com.typesafe.genjavadoc plugin, and use mvn javadoc:aggregate to generate javadoc,  however HBase use mvn site to generate javadoc.

The reason why mvn site can not generate javadoc successfully when using  genjavadoc plugin in hbase for the following reasons:
(1) Flink does not have annotations, but we have annotation like stable, privatelimited
(2) The fake java code generated by com.typesafe.genjavadoc plugin can not be used for mvn site, and can only be used by mvn javadoc. Because the generated fake code only have some definition and have no implementation, and the fake code can not pass the check by mvn site. 

I will just provide a patch about my proposal, so you guys can have a better understanding.



> Generate Javadoc for hbase-spark module 
> ----------------------------------------
>
>                 Key: HBASE-17766
>                 URL: https://issues.apache.org/jira/browse/HBASE-17766
>             Project: HBase
>          Issue Type: Bug
>            Reporter: Yi Liang
>            Assignee: Yi Liang
>             Fix For: 2.0.0
>
>         Attachments: HBASE-17766-V1.patch, spark-api.jpg, user-api.jpg
>
>
>  Scala classes in hbase-spark module aren't showing up in our API docs nor our internal API docs. see https://hbase.apache.org/apidocs/ 



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)