Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Not possible to add scaladoc comment for the generated template object #420

Open
ianknowles opened this issue May 14, 2021 · 1 comment
Open

Comments

@ianknowles
Copy link

ianknowles commented May 14, 2021

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.

@mkurz
Copy link
Member

mkurz commented May 14, 2021

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants