lightbend / genjavadoc

A compiler plugin for generating doc’able Java source from Scala source

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

The typ parameter tag "@tparam" does not work for functions

birkhola opened this issue · comments

class TaskBuilder(builder: DriverBuilder)
    extends my.core.java.common.builder.TaskBuilder {
 
    /** Uses a [[my.core.java.comparison.Comparator]] as compiler for the DriverTask being built.
      * This compiler can only run non-incrementally.
      *
      * NEXT LINE DOES NOT WORK:
      * @tparam C is the type of the values passed between compileIn and compileOut
      * INSTEAD WORKAROUND:
      * The type parameter C is the type of the values passed between compileIn and compileOut
      * The type parameter R is the type of the values returned by the test cases
      * @param comparator the compiler implementation
      * @return this [[TaskBuilder]]
      */
    def withComparator[C, R](id: String, comparator: Comparator[C, R]): this.type = { ... }

@birkhola Which version of genjavadoc are you using ? tparam should be supported since v0.11.

we can reopen if it turns out there's still an actual issue here