clang-uml/docs/test_cases/t00050.md

t00050 - Test case for generating notes from comments using jinja templates

Config

compilation_database_dir: ..
output_directory: puml
diagrams:
  t00050_class:
    type: class
    glob:
      - ../../tests/t00050/t00050.cc
    include:
      namespaces:
        - clanguml::t00050
    using_namespace: clanguml::t00050
    plantuml:
      after:
        - >
           note left of {{ alias("A") }}
              {{ comment("A") }}
           end note

        - >
          {% for element in diagram.elements %}
          {% if element.type == "class" and existsIn(element, "comment")  %}
          
          note top of {{ element.alias }}
             {{ element.comment }}
          end note
          
          {% endif %}
          {% endfor %}
        - >
          {% for element in diagram.elements %}
          {% if element.type == "enum" and existsIn(element, "comment") %}
          
          note bottom of {{ element.alias }}
             {{ element.comment }}
          end note
          
          {% endif %}
          {% endfor %}

Source code

File t00050.cc

namespace clanguml {

/// Vivamus integer non suscipit taciti mus
class A {
};

namespace t00050 {

/// Lorem ipsum dolor sit
class A {
};

/**
 * Lorem ipsum dolor sit amet consectetur adipiscing elit, urna consequat felis
 * vehicula class ultricies mollis dictumst, aenean non a in donec nulla.
 * Phasellus ante pellentesque erat cum risus consequat imperdiet aliquam,
 * integer placerat et turpis mi eros nec lobortis taciti, vehicula nisl litora
 * tellus ligula porttitor metus.
 */
class B {
};

/// Lorem ipsum dolor sit amet consectetur adipiscing elit, urna consequat felis
/// vehicula class ultricies mollis dictumst, aenean non a in donec nulla.
/// Phasellus ante pellentesque erat cum risus consequat imperdiet aliquam,
/// integer placerat et turpis mi eros nec lobortis taciti, vehicula nisl litora
/// tellus ligula porttitor metus.
///
/// Vivamus integer non suscipit taciti mus etiam at primis tempor sagittis sit,
/// euismod libero facilisi aptent elementum felis blandit cursus gravida sociis
/// erat ante, eleifend lectus nullam dapibus netus feugiat curae curabitur est
/// ad. Massa curae fringilla porttitor quam sollicitudin iaculis aptent leo
/// ligula euismod dictumst, orci penatibus mauris eros etiam praesent erat
/// volutpat posuere hac. Metus fringilla nec ullamcorper odio aliquam lacinia
/// conubia mauris tempor, etiam ultricies proin quisque lectus sociis id
/// tristique, integer phasellus taciti pretium adipiscing tortor sagittis
/// ligula.
///
/// Mollis pretium lorem primis senectus habitasse lectus scelerisque
/// donec, ultricies tortor suspendisse adipiscing fusce morbi volutpat
/// pellentesque, consectetur mi risus molestie curae malesuada cum. Dignissim
/// lacus convallis massa mauris enim ad mattis magnis senectus montes, mollis
/// taciti phasellus accumsan bibendum semper blandit suspendisse faucibus nibh
/// est, metus lobortis morbi cras magna vivamus per risus fermentum. Dapibus
/// imperdiet praesent magnis ridiculus congue gravida curabitur dictum
/// sagittis, enim et magna sit inceptos sodales parturient pharetra mollis,
/// aenean vel nostra tellus commodo pretium sapien sociosqu.
class C {
};

/// Mollis pretium lorem primis
namespace utils {

/// Lorem ipsum dolor sit amet consectetur adipiscing elit, urna consequat felis
/// vehicula class ultricies mollis dictumst, aenean non a in donec nulla.
/// Phasellus ante pellentesque erat cum risus consequat imperdiet aliquam,
/// integer placerat et turpis mi eros nec lobortis taciti, vehicula nisl litora
/// tellus ligula porttitor metus.
class D {
};

}

/// Mollis pretium lorem primis
enum class E { E1, E2, E3 };

class NoComment {
};

}
}

Generated UML diagrams