clang-uml/docs

@mainpage clang-uml

Documentation

clang-uml is an automatic C++ to UML class, sequence, package and include diagram generator, driven by YAML configuration files. The main idea behind the project is to easily maintain up-to-date diagrams within a code-base or document legacy code. The configuration file or files for clang-uml define the types and contents of each generated diagram. The diagrams can be generated in PlantUML, MermaidJS and JSON formats.

Example sequence diagram generated using clang-uml from this code:

clang-uml currently supports C++ up to version 17 with partial support for C++ 20.

To see what clang-uml can do, checkout the diagrams generated for unit test cases here or examples in clang-uml-examples repository.

These pages provide both user and developer documentation.

• Quick start
• Installation
• Generating diagrams
  • Common options
  • Generator types
  • Class diagrams
  • Sequence diagrams
  • Package diagrams
  • Include diagrams
  • Diagram templates
  • Comment decorators
  • Diagram filters
  • Using Jinja templates in diagram configs
  • Interactive SVG diagrams using links
• Configuration file reference
• Doxygen integration
• Test cases documentation
• Troubleshooting
• Changelog
• License
• Development
  • Architecture
  • Contributing