TypeGraph representations

If you want to show the hierarchy in the types defined in your module you can use TypeGraph.

TypeGraph file

At this moment, TypeGraph is not able to automatically detect the hierarchy of a documented class, so you need to provide this information in a file. There's two options to specify this file:

• Use the --typegraph-file to specify a custom path.

• Create a file named type-graph.txt file in your module directory.

How to write this file? You need to follow a special syntax:

[name of the category]
# you can write comments too!
Name::Of::A::Class is Parent::Class does A::ROle

You can check the type-graph.txt file used by Documentable as an example.