[
https://issues.apache.org/jira/browse/THRIFT-1971?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13657882#comment-13657882
]
Jake Farrell commented on THRIFT-1971:
--------------------------------------
Rodrigo, thank you for taking the time to work on this new generator and adding
the additional material like tutorials and documentation, greatly appreciated.
committed: http://thrift.apache.org/tutorial/graphiz/
> [Graphviz] Adds tutorial/general description documentation
> ----------------------------------------------------------
>
> Key: THRIFT-1971
> URL: https://issues.apache.org/jira/browse/THRIFT-1971
> Project: Thrift
> Issue Type: Documentation
> Components: Tutorial, Website
> Reporter: Rodrigo Setti
> Priority: Minor
>
> The documentation follows (in Markdown).
> {noformat}
> # Graphviz Generator Overview
> ## Introduction
> The Graphviz generator is a convenient way to generate documentation diagrams
> for your API. Usage:
> $ thrift --gen gv tutorial.thrift
> This will create the file `gen-gv/tutorial.gv`, which is a [Graphiz
> source](http://en.wikipedia.org/wiki/DOT_(graph_description_language)) - a
> plain-text description language used for graphs (in this case, for IDL's types
> and functions diagram). You will need to actually render those graphs into any
> of the supported output formats (e.g. PNG, PDFs, SVG, etc.) by using a Graphiz
> renderer in your platform.
> There are several Graphviz renderers, and it's available in most platforms and
> package managers. The [official renderers](http://www.graphviz.org/) can be
> used as a command line tool to produce a graphic from the `.gv` file:
> $ dot -Tpdf -otutorial.pdf gen-gv/tutorial.gv
> ## Extra options
> By default, the diagrams are not rendered with arrows from functions to
> exceptions (although the exception structures are displayed). You can set the
> generator to render those exceptions arrows (i.e. function throws) by using
> the
> "`exception`" option:
> $ thrift --gen:gv:exceptions gv tutorial.thrift
> ## Examples
> <!-- a list of diagram images, and maybe, their IDL counterparts -->
> {noformat}
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
