module Cruml

Overview

cruml (Crystal UML) is a library that allows to generate a UML diagram. This is useful for any Crystal projects.

require "cruml"

module Project
  # your module containing classes of all types.
end

# Your project module (e.g: Project)
::CRUML_FILTER_PREFIX = "Project"

# Directory where the diagram will be saved.
::CRUML_OUT_DIR = "./out/"

Cruml.run

Cruml uses macros to retrieve reflected classes.

Defined in:

annotations.cr
cruml.cr

Constant Summary

VERSION = "0.3.0"

Class Method Summary

• .run : Nil

  Proceed to the UML diagram generation.

Class Method Detail