1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Miscellaneous</title><link rel="stylesheet" href="synopsis.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.65.1"><link rel="home" href="index.html" title="Synopsis Tutorial"><link rel="up" href="using.html" title="Chapter2.Using the synopsis tool"><link rel="previous" href="comments.html" title="Using comments for documentation"><link rel="next" href="scripting.html" title="Chapter3.Scripting and extending synopsis"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Miscellaneous</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="comments.html">Prev</a></td><th width="60%" align="center">Chapter2.Using the synopsis tool</th><td width="20%" align="right"><a accesskey="n" href="scripting.html">Next</a></td></tr></table></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="misc"></a>Miscellaneous</h2></div></div><div></div></div><p>As discussed earlier, there is a variety of processors available in the
Synopsis distribution. There are a number of parsers (for IDL, Python, and C++,
a C parser is in development), some formatters (HTML is probably the most popular
one, but others such as ASCII, Texinfo, Docbook, or Dot may be useful, too),
and a number of linker processors.</p><p>To find out about the available options of each of them, use the <tt class="option">--help</tt>
option. For example
</p><pre class="programlisting">synopsis -f Dot --help</pre><p>
will tell us how to use the Dot formatter. To pass these options to the Dot formatter,
simply append them via the <tt class="option">-Wf</tt> option, and they will be forwarded.
</p><p>If we want to generate a (UML) class diagram, we could for example run
</p><pre class="programlisting">synopsis -f Dot -Wf,--title="class diagram" -Wf,--format=ps \
-Wf,hide_operations=False,hide_attributes=False \
-o Paths.ps Paths.syn</pre><p>
</p><p>But passing options via the command line has its limits, both, in terms of
usability, as well as for the robustness of the interface (all data have to be
passed as strings !). Therefor, for any tasks demanding more flexibility a
scripting interface is provided, which will be discussed in the next chapter.</p></div><div class="navfooter"><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="comments.html">Prev</a></td><td width="20%" align="center"><a accesskey="u" href="using.html">Up</a></td><td width="40%" align="right"><a accesskey="n" href="scripting.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Using comments for documentation</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">Chapter3.Scripting and extending synopsis</td></tr></table></div></body></html>
|
