<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">+50</td><td align="right" id="removed">-39</td><td nowrap="nowrap" align="center"><a href="http://svn.badgers-in-foil.co.uk/viewcvs.cgi/as2api/trunk/as2api/as2api-documentation.xml?rev=228&content-type=text/vnd.viewcvs-markup">228</a> <a href="http://svn.badgers-in-foil.co.uk/viewcvs.cgi/as2api/trunk/as2api/as2api-documentation.xml.diff?r1=228&r2=229">-></a> <a href="http://svn.badgers-in-foil.co.uk/viewcvs.cgi/as2api/trunk/as2api/as2api-documentation.xml?rev=229&content-type=text/vnd.viewcvs-markup">229</a></td></tr>
</table>
<pre class="comment">
Reformat lines in literal layouts for a shorter line length
</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=228&content-type=text/vnd.viewcvs-markup">228</a> <a href="http://svn.badgers-in-foil.co.uk/viewcvs.cgi/as2api/trunk/as2api/as2api-documentation.xml.diff?r1=228&r2=229">-></a> <a href="http://svn.badgers-in-foil.co.uk/viewcvs.cgi/as2api/trunk/as2api/as2api-documentation.xml?rev=229&content-type=text/vnd.viewcvs-markup">229</a></small></div>
<pre class="diff"><small id="info">--- trunk/as2api/as2api-documentation.xml 2005-08-13 21:49:57 UTC (rev 228)
+++ trunk/as2api/as2api-documentation.xml 2005-08-13 22:56:48 UTC (rev 229)
@@ -72,11 +72,12 @@
</small></pre><pre class="diff" id="context"> <wordasword>comment</wordasword> marker, for denoting text which
is not part of the executable program code. There is the C++
style single-line comment,</para>
</pre><pre class="diff" id="removed">- <programlisting><emphasis role="strong">//</emphasis> everything on the line after the two slashes<span id="removedchars"> is ignored</programlisting></span>
</pre><pre class="diff" id="added">+ <programlisting><emphasis role="strong">//</emphasis> everything on the line after the two slashes
+<emphasis role="strong">//</emphasis> is ignored</programlisting>
</pre><pre class="diff" id="context"> <para>and the C style multi-line comment,</para>
<programlisting><emphasis role="strong">/*</emphasis> text between start and end markers is
</pre><pre class="diff" id="removed">-ignored, and the comment may continue across multiple lines
-in the source code <emphasis role="strong">*/</emphasis></programlisting>
</pre><pre class="diff" id="added">+ ignored, and the comment may continue across
+ multiple lines in the source code <emphasis role="strong">*/</emphasis></programlisting>
</pre><pre class="diff" id="context"> </section>
<section>
</pre><pre class="diff"><small id="info">@@ -111,14 +112,14 @@
</small></pre><pre class="diff" id="context"> import "otherpackage.MyOtherClass";
<emphasis role="strong">/**
</pre><pre class="diff" id="removed">- * Objects of this class are responsible for serving as an example
- * to others.
</pre><pre class="diff" id="added">+ * Objects of this class are responsible for
+ * serving as an example to others.
</pre><pre class="diff" id="context"> */</emphasis>
class thispackage.MyFirstClass {
<emphasis role="strong">/**
</pre><pre class="diff" id="removed">- * When called, this method puts into motion a plan so cunning
- * that words cannot describe it.
</pre><pre class="diff" id="added">+ * When called, this method puts into motion a
+ * plan so cunning that words cannot describe it.
</pre><pre class="diff" id="context"> */</emphasis>
public function enactCunningPlan():Void {
// TODO: implement cunning plan
</pre><pre class="diff"><small id="info">@@ -341,12 +342,13 @@
</small></pre><pre class="diff" id="context"> <example>
<title>Class Description</title>
<programlisting><emphasis role="strong">/**
</pre><pre class="diff" id="removed">- * An immutable, type-safe wrapper around the String value of the
- * user identifier.
- * The constructor will raise an exception if the given value is not
- * of the correct format, asserting that the GUI validation code has
- * done its job, and preventing invalid data being sent to the
- * backend.
</pre><pre class="diff" id="added">+ * An immutable, type-safe wrapper around the
+ * String value of the user identifier.
+ * The constructor will raise an exception if
+ * the given value is not of the correct format,
+ * asserting that the GUI validation code has
+ * done its job, and preventing invalid data
+ * being sent to the backend.
</pre><pre class="diff" id="context"> */</emphasis>
class thispackage.UserId {
// ...
</pre><pre class="diff"><small id="info">@@ -367,11 +369,12 @@
</small></pre><pre class="diff" id="context"> <example>
<title>Method Description</title>
<programlisting><emphasis role="strong">/**
</pre><pre class="diff" id="removed">- * Clears all data that has previously been collected in this
- * object, and returns it to its initial state. Subclasses are
- * expected to override this method to clear any state of their
- * own, and use super() ensure that data defined by this class is
- * cleared too.
</pre><pre class="diff" id="added">+ * Clears all data that has previously been
+ * collected in this object, and returns it to
+ * its initial state. Subclasses are expected
+ * to override this method to clear any state of
+ * their own, and use super() ensure that data
+ * defined by this class is cleared too.
</pre><pre class="diff" id="context"> */</emphasis>
public function clear() {
// ...
</pre><pre class="diff"><small id="info">@@ -392,18 +395,22 @@
</small></pre><pre class="diff" id="context"> <example>
<title>Method Parameters</title>
<programlisting>/**
</pre><pre class="diff" id="removed">- * For each value contained by this object, invoke the given
- * callback function, passing the value as an argument.
</pre><pre class="diff" id="added">+ * For each value contained by this object, invoke
+ * the given callback function, passing the value
+ * as an argument.
</pre><pre class="diff" id="context"> *
</pre><pre class="diff" id="removed">- * <emphasis role="strong">@param callback</emphasis> callback function to be invoked for each object.
- * The function must accept one parameter (or two, if index
- * is true).
- * <emphasis role="strong">@param index</emphasis> if true, each invocation of the callback function
- * will be passed an additional second parameter giving the
- * index of the current value (starting with 0 for the first
- * value, 1 for the second, and so on).
</pre><pre class="diff" id="added">+ * <emphasis role="strong">@param callback</emphasis> callback function to be invoked
+ * for each object. The function must accept
+ * one parameter (or two, if index is true).
+ * <emphasis role="strong">@param index</emphasis> if true, each invocation of the
+ * callback function will be passed an
+ * additional second parameter giving the
+ * index of the current value (starting with
+ * 0 for the first value, 1 for the second,
+ * and so on).
</pre><pre class="diff" id="context"> */
</pre><pre class="diff" id="removed">-public function each(callback:Function, index:Boolean):Void {
</pre><pre class="diff" id="added">+public function each(callback:Function,
+ index:Boolean):Void {
</pre><pre class="diff" id="context"> // ...
}</programlisting>
</example>
</pre><pre class="diff"><small id="info">@@ -418,8 +425,8 @@
</small></pre><pre class="diff" id="context"> <programlisting>/**
* Get the value corresponding to the given key
*
</pre><pre class="diff" id="removed">- * <emphasis role="strong">@return</emphasis> either the value for the given key, or null if
- * there is no such mapping.
</pre><pre class="diff" id="added">+ * <emphasis role="strong">@return</emphasis> either the value for the given key, or
+ * null if there is no such mapping.
</pre><pre class="diff" id="context"> */
public function get(key:String):String {
// ...
</pre><pre class="diff"><small id="info">@@ -434,8 +441,9 @@
</small></pre><pre class="diff" id="context"> <example>
<title>Class Related information</title>
<programlisting>/**
</pre><pre class="diff" id="removed">- * See-also tags will be copied to the output HTML, but are not actually
- * turned into links to other classes/methods as they should be.
</pre><pre class="diff" id="added">+ * See-also tags will be copied to the output HTML,
+ * but are not actually turned into links to other
+ * classes/methods as they should be.
</pre><pre class="diff" id="context"> *
* <emphasis role="strong">@see "some stuff"</emphasis>
* <emphasis role="strong">@see some.OtherClass</emphasis>
</pre><pre class="diff"><small id="info">@@ -457,8 +465,8 @@
</small></pre><pre class="diff" id="context"> <programlisting>/**
* Causes this message to be sent
*
</pre><pre class="diff" id="removed">- * <emphasis role="strong">@throws MessagingException if there is a failure in
- * the underlying communications medium</emphasis>
</pre><pre class="diff" id="added">+ * <emphasis role="strong">@throws MessagingException if there is a failure
+ * in the underlying communications medium</emphasis>
</pre><pre class="diff" id="context"> */
public function send():Void {
// ...
</pre><pre class="diff"><small id="info">@@ -473,9 +481,11 @@
</small></pre><pre class="diff" id="context"> <example>
<title>Linking to Other Parts of the API</title>
<programlisting>/**
</pre><pre class="diff" id="removed">- * Causes this message to be sent to the <emphasis role="strong">{@link OtherClass}</emphasis>
- * instance, where it will be dealt with by <emphasis role="strong">{@link OtherClass#recieve()}</emphasis>.
- * We remember the destination in our <emphasis role="strong">{@link #reciever}</emphasis> field.
</pre><pre class="diff" id="added">+ * Causes this message to be sent to the
+ * <emphasis role="strong">{@link OtherClass}</emphasis> instance, where it will be
+ * dealt with by <emphasis role="strong">{@link OtherClass#recieve()}</emphasis>. We
+ * remember the destination in our <emphasis role="strong">{@link #reciever}</emphasis>
+ * field.
</pre><pre class="diff" id="context"> */
public function send():Void {
// ...
</pre><pre class="diff"><small id="info">@@ -490,8 +500,9 @@
</small></pre><pre class="diff" id="context"> <example>
<title>Example Code</title>
<programlisting>/**
</pre><pre class="diff" id="removed">- * Generates an ending XML tag. For example, if passed <emphasis role="strong">{@code "p"}</emphasis>,
- * the result will be <emphasis role="strong">{@code "&lt;/p&gt;"}</emphasis>
</pre><pre class="diff" id="added">+ * Generates an ending XML tag. For example, if
+ * passed <emphasis role="strong">{@code "p"}</emphasis>, the result will be
+ * <emphasis role="strong">{@code "&lt;/p&gt;"}</emphasis>
</pre><pre class="diff" id="context"> */
public function endTag(name:String):String {
// ...
</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>