[
https://issues.apache.org/jira/browse/THRIFT-1971?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Rodrigo Setti updated THRIFT-1971:
----------------------------------
Description:
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 [Graphviz
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}
was:
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}
> [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 [Graphviz
> 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
