Skip to content

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

Open
@ianknowles

Description

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.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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