vscode-terosHDL icon indicating copy to clipboard operation
vscode-terosHDL copied to clipboard

[Documenter] Member Groups

Open le-blue opened this issue 4 years ago • 1 comments

First of all, thank you for your wonderful toolset! I'd like to suggest a documenter feature:

Feature Request

  • Add possibility to split documentation of members (i.e. constants, functions, ...) of a file (package or architecture) into groups, just like Doxygen's Member Groups.
  • Support member group descriptions
  • Support bitfield rendering in member group descriptions

Background

I like to use packages to specify and document register interfaces, for the embedded system's colleagues that have to deal with my design. At least from my point of view, the grouping feature would increase the Documenter's value for every larger entity / package. In my particular use case, I'm dreaming of a Ref-manual-like register description coming directly from the Documenter.

Related

Might be related to:

  • #106
  • #71
  • Note: Wavedroms and bitfields are currently also not supported in a package description

le-blue avatar Feb 10 '22 11:02 le-blue

That sounds good. Could you send me and an email to [email protected] ?

qarlosalberto avatar Feb 10 '22 11:02 qarlosalberto