G'day,

Some people expressed interest in the graphs I used last night. I thought
I'd give a quick overview of how to make them. They're generated by
Doxygen, which is also capable of generating other kinds of documentation
such as manpages. You should be able to install Doxygen using your package
manager.

To generate documentation, you always have a config file, by default called
"Doxyfile". Then in the directory where your source code lives, run the
command,

    doxygen Doxyfile

If you don't have a config file, doxygen will generate one with:

    doxygen -g

The default Doxyfile doesn't trigger graph generation. For that, you need
to change some of the fields. Specifically, look for the following fields
in the Doxyfile and set their values accordingly:

    EXTRACT_ALL = YES
    HAVE_DOT = YES
    CALL_GRAPH = YES

The following might slow down doxygen for large projects but it is useful:

    CALLER_GRAPH = YES

YMMV, but I also think it's often good to have the following set:

    BUILTIN_STL_SUPPORT = YES
    INLINE_SOURCES = YES

In summary,

    1. Install doxygen.
    2. Go to the directory containing your source code.
    3. Run: doxygen -g
    4. Edit the resulting Doxyfile, especially EXTRACT_ALL, HAVE_DOT and
        CALL_GRAPH.
    5. Run: doxygen Doxyfile
    6. You should now find a subdirectory called "html". Inside will be a
        file called "index.html"; open it in your preferred (graphical)
        browser (not lynx or other console-based browsers).

I hope someone finds this useful :-).

Cheers,

Tim
--
PhD Candidate, NICTA
Melbourne University
E: t.r...@ms.unimelb.edu.au
W: http://www.ms.unimelb.edu.au/~trice

application_pgp-signature_part < 1K Download