You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@spark.apache.org by "Xiangrui Meng (JIRA)" <ji...@apache.org> on 2016/06/22 22:51:16 UTC

[jira] [Resolved] (SPARK-16153) A single-line ScalaDoc and @deprecate annotation would break genjavadoc

     [ https://issues.apache.org/jira/browse/SPARK-16153?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Xiangrui Meng resolved SPARK-16153.
-----------------------------------
       Resolution: Fixed
    Fix Version/s: 2.0.0

Issue resolved by pull request 13855
[https://github.com/apache/spark/pull/13855]

> A single-line ScalaDoc and @deprecate annotation would break genjavadoc
> -----------------------------------------------------------------------
>
>                 Key: SPARK-16153
>                 URL: https://issues.apache.org/jira/browse/SPARK-16153
>             Project: Spark
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 2.0.0
>            Reporter: Xiangrui Meng
>            Assignee: Xiangrui Meng
>             Fix For: 2.0.0
>
>
> Env: Scala 2.11.8, Java 1.7.0_79
> We recently deprecated setLabelCol in ChiSqSelectorModel:
> {code}
>   /** @group setParam */
>   @Since("1.6.0")
>   @deprecated("labelCol is not used by ChiSqSelectorModel.", "2.0.0")
>   def setLabelCol(value: String): this.type = set(labelCol, value)
> {code}
> This unfortunately hit a genjavadoc bug and broken doc generation. This is the generated Java code:
> {code}
>   /** @group setParam */
>   public  org.apache.spark.ml.feature.ChiSqSelectorModel setOutputCol (java.lang.String value)  { throw new RuntimeException(); }
>    *
>    * @deprecated labelCol is not used by ChiSqSelectorModel. Since 2.0.0.
>   */
>   public  org.apache.spark.ml.feature.ChiSqSelectorModel setLabelCol (java.lang.String value)  { throw new RuntimeException(); }
> {code}
> Switching to multiline is a workaround. Reported the bug to genjavadoc at https://github.com/typesafehub/genjavadoc/issues/85.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@spark.apache.org
For additional commands, e-mail: issues-help@spark.apache.org