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

doc_table outputs multiline comments and single line comments #13

Open
lcaballero opened this issue Mar 30, 2016 · 0 comments
Open

doc_table outputs multiline comments and single line comments #13

lcaballero opened this issue Mar 30, 2016 · 0 comments

Comments

@lcaballero
Copy link
Owner

For clarity doc_table outputs all comments, but it might be useful to ignore multi-line comments for a field so that those comments can be used internally to group fields in the code. For example:

type Conf struct {
    /*** Image config **/
    // MaxWidth controls maximum image width
    MaxWidth int
    // MaxHeight controls maximum image height
    MaxHeight int

    /** User config **/
    // DefaultOwner when no is specified.
    DefaultOwner string
}

The output would skip any /* .... */ comments but put the // comments in the resulting data-structure that is used in the template.

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

1 participant