Jira (PDOC-123) Support groups of parameters

[Dominic Cleal (JIRA)]

Title: Message Title

Dominic Cleal created an issue   Puppet Strings / PDOC-123 Support groups of parameters Issue Type: Improvement Affects Versions: PDOC 0.99.0 Assignee: Unassigned Created: 2016/10/11 2:49 AM Priority: Normal Reporter: Dominic Cleal Support for grouping of parameters with a group name would be useful when documenting classes with tens of parameters, e.g. for "advanced parameters", "database connection parameters". It appears that YARD has @!group and @!endgroup directives already, so a doc format such as this might work: @!group Database connection @param db_adapter Database adapter name @param db_host Database server hostname @param db_username Username to authenticate with @!endgroup and I'd expect group within the tags in the JSON output, with parameters nested below: "docstring": { "tags": [ { "tag_name": "group", "docstring": { "text": "Database connection", "tags": [ { "tag_name": "param", "text": "Database adapter name", "types": [ "String" ], "name": "db_adapter" }, .... ] } } ] } Add Comment   This message was sent by Atlassian JIRA (v6.4.14#64029-sha1:ae256fe) -- You received this message because you are subscribed to the Google Groups "Puppet Bugs" group. To unsubscribe from this group and stop receiving emails from it, send an email to puppet-bugs+unsubscr...@googlegroups.com. To post to this group, send email to puppet-bugs@googlegroups.com. Visit this group at https://groups.google.com/group/puppet-bugs. For more options, visit https://groups.google.com/d/optout.