README 1.34 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
About
=====

http://code.google.com/p/doxygraph

This is doxygraph, a Perl script that will generate a diagram in Graphviz dot
format, using as input the XML based format generated by Doxygen. Doxygraph is
part of doxygraph, a free system for reverse engineering UML class diagrams from
source code, and presenting those diagrams as interactive web apps.

Dependencies
============

The following CPAN modules are required:

    File::Spec
    GraphViz2
    Hash::FieldHash
    lib::abs
    Moose
    namespace::autoclean
    XML::Rabbit

Usage
=====

The doxygraph Perl script can be used without needing to install it, although a
Makefile is provided for optional installation.

The script expects two commandline arguments: the first is the name of the input
file (usually index.xml generated by Doxygen) and the second is the name of the
output file.

To instruct Doxygen to generate XML output, set the option GENERATE_XML = YES
in your Doxyfile.

Installation
============

If you want to install doxygraph, follow the usual procedure for installing Perl
modules:

    perl Makefile.PL
    make
    make install

License
=======

Copyright 2013 Doxygraph project

These Source Code Forms are subject to the terms of the Mozilla Public License,
version 2.0. If a copy of the MPL was not distributed with this file, You can
obtain one at http://mozilla.org/MPL/2.0/.