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

Add option to automatically add element comments in diagrams #298

Open
bkryza opened this issue Jul 26, 2024 · 0 comments
Open

Add option to automatically add element comments in diagrams #298

bkryza opened this issue Jul 26, 2024 · 0 comments
Labels
class diagrams enhancement New feature or request
Milestone

Comments

@bkryza
Copy link
Owner

bkryza commented Jul 26, 2024

Currently, to add comments in class diagrams, it is necessary to add a jinja template, with a for loop iterating over all elements in the diagram, which is very convoluted.

There should be an option, similar to generate_message_comments in sequence diagrams, which would
just generate diagrams with some sensible defaults for all elements which have a comments. There could be some simple options, such as:

generate_element_comments:
  brief: true # Only brief text from Doxygen comments, or none if no brief is provided (default false)
  max_length: 256 # Keep only 256 characters of a comment at maximum (0 - no limit - default)
  format: [as_is, auto] # In practice raw comment as extracted from code will look ugly
                        # in a diagram because of intendation, new lines, etc. `auto` option
                        # should process the comment to make it look better (if possible)
@bkryza bkryza added enhancement New feature or request class diagrams labels Jul 26, 2024
@bkryza bkryza added this to the 0.5.4 milestone Jul 26, 2024
@bkryza bkryza modified the milestones: 0.5.4, 0.5.5 Aug 15, 2024
@bkryza bkryza modified the milestones: 0.5.5, 0.5.6 Oct 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
class diagrams enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant