twirl icon indicating copy to clipboard operation
twirl copied to clipboard

Not possible to add scaladoc comment for the generated template object

Open ianknowles opened this issue 4 years ago • 1 comments

Adding a scaladoc comment to the start of a template file like the example from the documentation:

@*************************************
 * Home page.                        *
 *                                   *
 * @param msg The message to display *
 *************************************@
@()

generates a scaladoc comment for the apply method of the template. This is correct and expected but it means its not possible to comment on the object.

Given the standard scaladoc formatting an object comment is the best place to document a more complex template, the method comment just doesn't give room for or expect lengthy comments.

ianknowles avatar May 14 '21 12:05 ianknowles

@ianknowles If you want to provide a pull request, we are happy to review it :wink:

mkurz avatar May 14 '21 12:05 mkurz