Graphviz for documentation.

Posted by Marcin on Stack Overflow See other posts from Stack Overflow or by Marcin
Published on 2008-11-19T22:23:08Z Indexed on 2010/05/11 11:34 UTC
Read the original article Hit count: 257

Filed under:

doxygen

|

graphviz

|

documentation-generation

|

uml

I noticed that doxygen uses the graphviz library for creating diagrams. Have you ever used graphviz for generating documentation? Is it worth learning the graphviz for documentation purposes outside the scope of doxygen? Or am I better off to sticking with a standard data modeling package like Visio?

I understand the merits of it as a graphing library, but for trying to represent more complex UML (or similar) is it still worth looking into?

© Stack Overflow or respective owner

Related posts about doxygen

Exclude some classes from doxygen documentation

as seen on Stack Overflow - Search for 'Stack Overflow'
I am building a Qt based project, and many Qt classes are found in the target documentation. How can I tell Doxygen to disable documentation generation for some classes? For Q.*? >>> More
Doxygen C++ comment string parser in python?

as seen on Stack Overflow - Search for 'Stack Overflow'
Does anybody know of a python module to parse a doxygen style C++ comment string? I mean a string like this (simple example): /** * A constructor. * A more elaborate description of the constructor. * @param param1 test1 * @param param2 test2 */ and I would like to extract the brief… >>> More
Customizing doxygen output for the HTML Table of Contents

as seen on Stack Overflow - Search for 'Stack Overflow'
I'm using doxygen to generate an API reference from source code, aiming to convert it into a CHM help file and eventually into a plugin for Eclipse. Unfortunately the default ordering and nesting of the classes, namespaces, etc. in the Table of Contents is not exactly ideal and I'd prefer to customize… >>> More
Is there any way to integrate doxygen with svn

as seen on Stack Overflow - Search for 'Stack Overflow'
Is there any way to configure doxygen to include the log from svn for a file as part of the output. Basically we enter pretty rigorous log messages into svn when we do commits, and I'd like those messages to have a section inside the doxygen output. >>> More
GNU autoconf, document options using doxygen?

as seen on Stack Overflow - Search for 'Stack Overflow'
hi Is it possible to document configure.ac such that doxygen can pick up embedded comments and produce documentation for options, variables, etc. in generated manuals? Thanks >>> More

Related posts about graphviz

Control layout using graphviz twopi

as seen on Stack Overflow - Search for 'Stack Overflow'
I am trying to draw a graph showing search prefixes using twopi. I have a simple input file and am getting this output: (full image) Here is the input file: digraph search { // ordering=out; // color=blue; // rank=same; // overlap=scale; rankdir=LR; root=root; ranksep=1.25; overlap=true; "root"; a… >>> More
Why does Graphviz fail on gvLayout?

as seen on Stack Overflow - Search for 'Stack Overflow'
Once again, here I am writing C without really knowing what I'm doing... I've slapped together a simple function that I can call from a C# program that takes a DOT string, an output format, and a file name and renders a graph using Graphviz. #include "types.h" #include "graph.h" #include "gvc.h" #define… >>> More
How to generate multiple levels with GraphViz (Image_Graphviz interface for PHP)

as seen on Stack Overflow - Search for 'Stack Overflow'
Hi, i'm trying to generate the following diagram using Image_GraphViz for PEAR. However It only shows a top-level node (with the text "0") and childnodes "1", "2", "3" and "4" directly under the top-node. Am I missing something? This is the code: $gv = new Image_GraphViz(true); $gv->addEdge(array('1'… >>> More
Graphviz or Dynagraph for Graph-manipulation Program?

as seen on Stack Overflow - Search for 'Stack Overflow'
I'm looking into writing a program that will show a graph to the user. The graph will change over time (the user should be able to right-click on a graph item and ask for more detail, which will pop out new bits of the graph), and the user might be able to drag parts of the graph around. I would ideally… >>> More
How can I use the Graphviz macro in XWiki 2.0 syntax?

as seen on Stack Overflow - Search for 'Stack Overflow'
The XWiki FAQ gives an example for XWiki 1.0 syntax: {graphviz:type=dot}digraph G {Hello->world}{graphviz} My XWiki is properly set up to display this. But I'm not able to translate this into XWiki 2.0 syntax. I tried this {{graphviz type=dot}} ... {{/graphviz}} and other variations, but… >>> More