Skip to content

Single-line ScalaDoc plus deprecated annotation would trigger a bug #85

Open

Description

@mengxr

We recently deprecated setLabelCol in ChiSqSelectorModel in Spark (apache/spark#13823):

  /** @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)

This unfortunately hit a genjavadoc bug and broken doc generation. This is the generated Java 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(); }

Switching to multiline is a workaround (apache/spark#13855). It would be nice to fix this bug in genjavadoc.

Activity

  1. patriknw commented on Oct 20, 2016

    @patriknw
    Contributor
  2. added 2 commits that reference this issue on Nov 29, 2016
  3. added 3 commits that reference this issue on Sep 18, 2017
    d898589
    93dca5c
    7352a96
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions