Merge pull request #318 from bkryza/add-repeated-activity-folding

Add repeated activity folding

Author: bkryza

.clang-uml

@@ -15,6 +15,7 @@ mermaid:
 generate_links:
   link: "{% if existsIn(element, \"doxygen_link\") %}{{ element.doxygen_link }}{% endif %}"
   tooltip: "{% if existsIn(element, \"comment\") and existsIn(element.comment, \"brief\") %}{{ abbrv(trim(replace(element.comment.brief.0, \"\\n+\", \" \")), 256) }}{% else %}{{ element.name }}{% endif %}"
+fold_repeated_activities: true
 diagrams:
   # Class diagrams
   class_translation_unit_visitor:

docs/sequence_diagrams.md

@@ -9,6 +9,7 @@
 * [Customizing participants order](#customizing-participants-order)
 * [Generating return types](#generating-return-types)
 * [Generating condition statements](#generating-condition-statements)
+* [Folding repeated activities](#folding-repeated-activities)
 * [Injecting call expressions manually through comments](#injecting-call-expressions-manually-through-comments)
 * [Including comments in sequence diagrams](#including-comments-in-sequence-diagrams)
 
@@ -325,6 +326,23 @@ generate_condition_statements: true
 An example of a diagram with this feature enabled is presented below:
 ![extension](test_cases/t20033_sequence.svg)
 
+## Folding repeated activities
+If in a given sequence diagram functions or methods are called multiple times
+from different branches, each of these activities will be rendered fully
+which can mean that the diagram be very large.
+
+In order to minimize the diagram size in such situations, an option can be set:
+
+```yaml
+fold_repeated_activities: true
+```
+
+which will render any activity only once, and any further calls to that activity
+will only render a call to the activity and an indicator - a single `*` character
+- in a note over the activity.
+
+For an example of this see the test case [t20056](test_cases/t20056.md).
+
 ## Injecting call expressions manually through comments
 In some cases, `clang-uml` is not yet able to discover a call expression target
 in some line of code. This can include passing function or method address to

docs/test_cases.md

@@ -144,6 +144,7 @@
  * [t20053](./test_cases/t20053.md) - Test case for inlining nested lambda operator calls
  * [t20054](./test_cases/t20054.md) - Test case for sequence diagram with nested classes
  * [t20055](./test_cases/t20055.md) - Test case for advanced filter in sequence diagram
+ * [t20056](./test_cases/t20056.md) - Test case for option to fold repeated activities in sequence diagram
 ## Package diagrams
  * [t30001](./test_cases/t30001.md) - Basic package diagram test case
  * [t30002](./test_cases/t30002.md) - Package dependency test case