<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">+44</td><td align="right" id="removed">-1</td><td nowrap="nowrap" align="center"><a href="http://svn.badgers-in-foil.co.uk/viewcvs.cgi/as2api/trunk/as2api/as2api-documentation.xml?rev=232&content-type=text/vnd.viewcvs-markup">232</a> <a href="http://svn.badgers-in-foil.co.uk/viewcvs.cgi/as2api/trunk/as2api/as2api-documentation.xml.diff?r1=232&r2=233">-></a> <a href="http://svn.badgers-in-foil.co.uk/viewcvs.cgi/as2api/trunk/as2api/as2api-documentation.xml?rev=233&content-type=text/vnd.viewcvs-markup">233</a></td></tr>
</table>
<pre class="comment">
Improve documentation for the {@code} tag.
</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=232&content-type=text/vnd.viewcvs-markup">232</a> <a href="http://svn.badgers-in-foil.co.uk/viewcvs.cgi/as2api/trunk/as2api/as2api-documentation.xml.diff?r1=232&r2=233">-></a> <a href="http://svn.badgers-in-foil.co.uk/viewcvs.cgi/as2api/trunk/as2api/as2api-documentation.xml?rev=233&content-type=text/vnd.viewcvs-markup">233</a></small></div>
<pre class="diff"><small id="info">--- trunk/as2api/as2api-documentation.xml 2005-08-13 23:53:24 UTC (rev 232)
+++ trunk/as2api/as2api-documentation.xml 2005-08-14 00:47:14 UTC (rev 233)
@@ -653,7 +653,19 @@
</small></pre><pre class="diff" id="context"> <section id="code_tag">
<title>Giving Code Examples</title>
</pre><pre class="diff" id="removed">- <para><remark>TODO</remark></para>
</pre><pre class="diff" id="added">+ <para>The code tag is provided to allow example ActionScript source
+ code to be included in the documentation. The advantage of
+ <literal>{@code}</literal> over simply using the HTML
+ <sgmltag class="starttag">code</sgmltag> tag is that you don't need to
+ worry about 'escaping' characters (like '&amp;', which are special in
+ HTML) within the example code.</para>
+
+ <para>In addition, as2api will apply 'syntax highlighting' to the
+ text within <literal>{@code}</literal>, which makes it look pretty.
+ The disadvantage of this is that you can expect to see problems if
+ you make certain classes of syntax error in the contents of the
+ tag (e.g. failing to close a string literal).</para>
+
</pre><pre class="diff" id="context"> <example>
<title>Example Code</title>
<programlisting>/**
</pre><pre class="diff"><small id="info">@@ -665,6 +677,37 @@
</small></pre><pre class="diff" id="context"> // ...
}</programlisting>
</example>
</pre><pre class="diff" id="added">+
+ <para><literal>{@code}</literal> may span multiple lines, and when
+ this happens, the resulting documentation will include an HTML
+ <sgmltag class="starttag">pre</sgmltag> around the code so that its
+ formatting is preserved.</para>
+
+ <para>Larger ActionScript code examples may need to include braces
+ (the '{' and '}' characters), however the end of the
+ <literal>{@code}</literal> will be marked by the closing brace.
+ Nested braces <emphasis>are</emphasis> allowed within
+ <literal>{@code}</literal>, but each opening brace,
+ <emphasis>must</emphasis> have a matching closing brace.</para>
+
+ <example>
+ <title>Complex, multi-line code</title>
+ <programlisting>/**
+ * Returns the result of calling startTag(), the
+ * given bodyGenerator function and endTag(),
+ * concatenated together. For example, one might
+ * pass an anonymous function:
+ * <emphasis role="strong">{@code
+ * out.element("head", function() {
+ * return "some dynamicaly generated content";
+ * });
+ * }</emphasis>
+ */
+public function element(name:String,
+ bodyGenerator:Function):String {
+ // ...
+}</programlisting>
+ </example>
</pre><pre class="diff" id="context"> </section>
</section>
</section>
</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>