<html>
<head>
<style><!--
body {background-color:#ffffff;}
.file {border:1px solid #eeeeee;margin-top:1em;margin-bottom:1em;}
.pathname {font-family:monospace; float:right;}
.fileheader {margin-bottom:.5em;}
.diff {margin:0;}
.tasklist {padding:4px;border:1px dashed #000000;margin-top:1em;}
.tasklist ul {margin-top:0;margin-bottom:0;}
tr.alt {background-color:#eeeeee}
#added {background-color:#ddffdd;}
#addedchars {background-color:#99ff99;font-weight:bolder;}
tr.alt #added {background-color:#ccf7cc;}
#removed {background-color:#ffdddd;}
#removedchars {background-color:#ff9999;font-weight:bolder;}
tr.alt #removed {background-color:#f7cccc;}
#info {color:#888888;}
#context {background-color:#eeeeee;}
td {padding-left:.3em;padding-right:.3em;}
tr.head {border-bottom-width:1px;border-bottom-style:solid;}
tr.head td {padding:0;padding-top:.2em;}
.task {background-color:#ffff00;}
.comment {padding:4px;border:1px dashed #000000;background-color:#ffffdd}
.error {color:red;}
hr {border-width:0px;height:2px;background:black;}
--></style>
</head>
<body>
<table cellspacing="0" cellpadding="0" border="0" rules="cols">
<tr class="head"><td colspan="4">Commit in <b><tt>trunk/as2api</tt></b><span id="info"> on MAIN</span></td></tr>
<tr><td><tt><a href="#file1">as2api-documentation.xml</a></tt></td><td align="right" id="added">+175</td><td></td><td nowrap="nowrap" align="center"><a href="http://svn.badgers-in-foil.co.uk/viewcvs.cgi/as2api/trunk/as2api/as2api-documentation.xml?rev=221&content-type=text/vnd.viewcvs-markup">221</a> <a href="http://svn.badgers-in-foil.co.uk/viewcvs.cgi/as2api/trunk/as2api/as2api-documentation.xml.diff?r1=221&r2=222">-></a> <a href="http://svn.badgers-in-foil.co.uk/viewcvs.cgi/as2api/trunk/as2api/as2api-documentation.xml?rev=222&content-type=text/vnd.viewcvs-markup">222</a></td></tr>
</table>
<pre class="comment">
Command line reference documentation
</pre>
<hr /><a name="file1" /><div class="file">
<span class="pathname"><a
href="http://svn.badgers-in-foil.co.uk/viewcvs.cgi/as2api/trunk">trunk</a>/<a
href="http://svn.badgers-in-foil.co.uk/viewcvs.cgi/as2api/trunk/as2api">as2api</a></span><br />
<div class="fileheader"><big><b>as2api-documentation.xml</b></big> <small id="info"><a href="http://svn.badgers-in-foil.co.uk/viewcvs.cgi/as2api/trunk/as2api/as2api-documentation.xml?rev=221&content-type=text/vnd.viewcvs-markup">221</a> <a href="http://svn.badgers-in-foil.co.uk/viewcvs.cgi/as2api/trunk/as2api/as2api-documentation.xml.diff?r1=221&r2=222">-></a> <a href="http://svn.badgers-in-foil.co.uk/viewcvs.cgi/as2api/trunk/as2api/as2api-documentation.xml?rev=222&content-type=text/vnd.viewcvs-markup">222</a></small></div>
<pre class="diff"><small id="info">--- trunk/as2api/as2api-documentation.xml 2005-08-07 22:42:53 UTC (rev 221)
+++ trunk/as2api/as2api-documentation.xml 2005-08-13 12:30:07 UTC (rev 222)
@@ -504,4 +504,179 @@
</small></pre><pre class="diff" id="context"> </section>
</section>
</section>
</pre><pre class="diff" id="added">+
+ <refentry id="as2api">
+ <refmeta>
+ <refentrytitle>as2api</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>as2api</refname>
+ <refpurpose>ActionScript 2 API reference documentation
+ generator</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>as2api</command>
+ <arg>--help</arg>
+ <arg>--output-dir <replaceable>path</replaceable></arg>
+ <arg>--classpath <replaceable>path</replaceable></arg>
+ <arg>--title <replaceable>title-text</replaceable></arg>
+ <arg>--progress</arg>
+ <arg>--encoding <replaceable>encoding-name</replaceable></arg>
+ <arg>--draw-diagrams</arg>
+ <arg>--dot-exe <replaceable>executable-path-and-name</replaceable></arg>
+ <arg>--sources</arg>
+ <arg rep="repeat" choice="plain"><replaceable>package-spec</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsection id="options">
+ <title>Options</title>
+
+ <para>Arguments can be given in any order.
+ <replaceable>package-spec</replaceable> is required.</para>
+
+ <variablelist>
+ <varlistentry>
+ <term><option><replaceable>package-spec</replaceable></option></term>
+ <listitem>
+ <para>You must specify at least one package of types to be
+ documented, and may specify multiple packages:</para>
+
+ <informalexample>
+ <screen>as2api org.example.utils com.yoyodyne.app</screen>
+ </informalexample>
+
+ <para>If you want to document all packages who's names share a
+ common prefix, you can avoid listing each package individually by
+ giving the package prefix with the suffix '.*':</para>
+
+ <informalexample>
+ <screen>as2api com.yoyodyne.gui.*</screen>
+ </informalexample>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--help</option></term>
+ <term><option>-h</option></term>
+ <listitem>
+ <para>Causes the program to exit immidiately after showing some
+ brief usage instructions.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--output-dir <replaceable>path</replaceable></option></term>
+ <term><option>-d <replaceable>path</replaceable></option></term>
+ <listitem>
+ <para><replaceable>path</replaceable> specifies the location where
+ the generated HTML files should be placed. If unspecified, the
+ default location will be <filename>apidocs</filename>, within
+ the current directory.</para>
+
+ <para>If <replaceable>path</replaceable> does not exist, it will
+ be created.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--classpath <replaceable>path</replaceable></option></term>
+ <listitem>
+ <para>The <replaceable>path</replaceable> is a list of directories
+ in which as2api should search for source code. If no classpath is
+ specified, as2api just searches within the current
+ directory. Items within the list should be seperated by the
+ platform-dependant path seperator:</para>
+
+ <variablelist>
+ <varlistentry>
+ <term>Windows</term>
+
+ <listitem>
+ <para>--classpath <replaceable>dir1</replaceable>;<replaceable>dir2</replaceable></para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>OSX</term>
+ <term>Unix</term>
+
+ <listitem>
+ <para>--classpath <replaceable>dir1</replaceable>:<replaceable>dir2</replaceable></para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>Note that if one of the directories in the classpath contains
+ spaces, you will need to enclose the whole classpath in
+ quotes:</para>
+
+ <informalexample>
+ <screen>--classpath "C:\Documents and Settings\dave\as;<replaceable>dir2</replaceable>"</screen>
+ </informalexample>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--title <replaceable>title-text</replaceable></option></term>
+ <listitem>
+ <para>Some text to be included in the titles of generated pages
+ (e.g. the name of the software project / library).</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--progress</option></term>
+ <listitem>
+ <para>Causes some extra progress information to be shown as the
+ program runs</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--encoding <replaceable>encoding-name</replaceable></option></term>
+ <listitem>
+ <para>The encoding for the generated HTML files. Note that this
+ must match the encoding of all input source files; no transcoding
+ is performed. as2api cannot handle a mixture of file encodings in
+ the set of source files to be proccessed.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--draw-diagrams</option></term>
+ <listitem>
+ <para>Enables the generation of inheritance diagrams on package
+ overview pages. This requires the external <command>dot</command>
+ tool from the graphviz package. If you have downloaded graphviz,
+ but the tools are not available in the standard system PATH,
+ you will need to specify the location of <command>dot</command>
+ by adding <option>--dot-exe</option> to the command line.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--dot-exe <replaceable>executable-path-and-name</replaceable></option></term>
+ <listitem>
+ <para>Explicitly names the <command>dot</command> executable to use,
+ should this not be available in any of the standard locations on
+ your system.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--sources</option></term>
+ <listitem>
+ <para>Enables the inclusion of a copy of the source code of each
+ documented type in the generated HTML. The source will be
+ converted to an HTML file with 'syntax highlighting'.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsection>
+ </refentry>
</pre><pre class="diff" id="context"> </article>
</pre></div>
<center><small><a href="http://www.badgers-in-foil.co.uk/projects/cvsspam/" title="commit -> email">CVSspam</a> 0.2.11</small></center>
</body></html>