Synopsis 0.5 - User Manual

Dot

This formatter uses the 'dot' tool, a part of GraphViz, to generate graphs of the AST. It is mostly used by the HTML formatter for generating inheritance graphs, but can also be used as a stand-alone formatter. It can currently generate two types of diagram: inheritance and single. The inheritance diagram shows the entire hierarchy, whereas the single diagram shows only the hierarchy starting at a given class, and going one level down and all the way up to the top-level parent class(es). The former is used by the InheritanceGraph HTML page, and the latter by the individual class pages.

The Dot formatter does not support any config options yet, however some command line options are still supported. Don't forget to set them using the "-Wf,-foo" syntax!

-o filename

Specifies an output filename. You do not need to use the special syntax for this option.

-v

Enables verbose operation.

-t title

Specifies a title for the graph

-i

Specifies an "inheritance" style graph, showing all classes.

-s

Specifies a "single" style graph, showing only the graph related to a single class.

-O

Causes operations to be shown

-A

Causes attributes to be shown

-f format

Specifies an output format, can be one of:

dot

GraphViz dot file.

ps

PostScript file.

png

Portable Network Graphic file, for use in web pages.

gif

Graphics Interchange Format, for use in web pages (prefer png due to patent issues).

map

HTML map segment, for embedding in web pages with links to classes.

html

HTML segment, for embedding in web pages with links to classes or as a standalone page.

-r tocfile

Specifies a TOC file to read, allowing the generation of links to the classes in the graph. See the HTML formatter for more info about TOC files.

-R classname

Specifies the origin of the graph for Single graphs

-d direction

Specifies the direction. Can be 'horizontal' or 'vertical'.