genjavadoc icon indicating copy to clipboard operation
genjavadoc copied to clipboard

make comments on method arguments travel into that methods/constructor’s doc

Open rkuhn opened this issue 13 years ago • 2 comments
trafficstars

class A(/** comment */ val x: Int)

rkuhn avatar Aug 30 '12 11:08 rkuhn

How to document the constructor? I have tried several options but generated code always has '// not preceding' before the constructor.

Things I tried:

  • 2nd block /**
    • class comment / /*
    • Constructor comment */ case class Test(arg: String)
  • before class name case class /** constructor docs */ Test(arg: String)
  • after class name case class Test /** appears at argument */(arg: String)

diversit avatar May 27 '15 13:05 diversit

Yes, this is an open issue and I have currently no time to work on it—if you have an idea please share.

rkuhn avatar May 27 '15 14:05 rkuhn