﻿<?xml version="1.0"?><documentation generator="AS2Doc" version="1.1.1" dateCreated="16.02.2005 17:17:27"><project><options><option name="title"><![CDATA[Default Project API Documentation]]></option><option name="description"><![CDATA[This is a documentation.]]></option><option name="public"/><option name="styles"><style selected="true"><name>AS2 Stub Code</name><version>1.0.1</version><parameters><parameter name="withmetadata" module="bool" description="Copy metadata from sourcefiles">true</parameter></parameters></style></option><option name="xmlonly"/></options></project><package ns="com.as2doc" id="examples"><classes><class ns="com.as2doc.examples" id="CTest" file="CTest.as" lastmodified="16.02.2005 17:06:24"><imports><import ns="com.as2doc" id="*"/><import ns="com.as2doc.examples" id="*"/></imports><comments><comment tag="comment"><![CDATA[Testclass used as an example for AS2Doc tag documentation. ]]></comment><comment tag="author"><![CDATA[Mirell Development (<a href="mailto:spam0@as2doc.com">spam0@as2doc.com</a>)]]></comment><comment tag="author"><![CDATA[Second author]]></comment><comment tag="version"><![CDATA[1.0.0]]></comment><comment tag="version"><![CDATA[Special build version line spanning multiple lines]]></comment><comment tag="description"><![CDATA[This testclass, once generated, validates if<p> Code is shown correctly <code>test code</code>. HTML Tags work like they are supposed to: <p> And more code: <pre>
var myTest: CTest = new CTest("this is a test");</pre> <p>In-line picture: <img src="{@docRoot}as2doc.png"><br> Documentation Root Directory: {@docRoot}<br> Some inline links: {@link CTestSuperClass}<br> Another one {@link #returnOne links to the returnOne member.}]]></comment><comment tag="usage"><![CDATA[<pre>myTest = new CTest(p1[, p2]);
trace(CTest.ClassName);
trace(myTest.aProperty);
 
function test()
{
	// Some code in here
	trace(CTest.{@link #ClassName});
}
test();
</pre>]]></comment><comment tag="since"><![CDATA[Test API 1.0]]></comment><comment tag="see"><![CDATA["The Book about API 1.0"]]></comment><comment tag="see"><![CDATA[<a href="http://www.as2doc.com">AS2Doc</a>]]></comment><comment tag="see"><![CDATA[#methodOne Label for methodOne]]></comment><comment tag="see"><![CDATA[ITest]]></comment><comment tag="see"><![CDATA[InputVariations]]></comment><comment tag="see"><![CDATA[some.other.UnknownClass]]></comment><comment tag="see"><![CDATA[CTest#returnOne]]></comment><comment tag="see"><![CDATA[com.as2doc.examples]]></comment><comment tag="see"><![CDATA[com.as2doc.examples.CTest]]></comment><comment tag="see"><![CDATA[com.as2doc]]></comment><comment tag="see"><![CDATA[UnknownClass]]></comment><comment tag="myowntag"><![CDATA[Any tag of that form will be recognized as a custom tag. It is allowed to span multiple lines aswell. The style used to generate the documentation,  has to have built-in support for custom tags in order  to make them appear/work.]]></comment></comments><modifiers><dynamic/></modifiers><extends ns="com.as2doc" id="CTestSuperClass"/><implements><interface ns="com.as2doc.examples" id="ITest"/></implements><members><field id="_newPosition" type="Number"><comments><comment tag="comment"><![CDATA[Position which may appear in the future.]]></comment></comments><modifiers><public/><static/></modifiers></field><field id="_maxPosition" type="Number"><comments><comment tag="comment"><![CDATA[The maximum position to index into a string.]]></comment></comments><modifiers><public/><static/></modifiers></field><field id="x" type="Number"><comments><comment tag="comment"><![CDATA[Documentation generates two fields entries with this comment.]]></comment></comments><modifiers><public/></modifiers></field><field id="y" type="Number"><comments><comment tag="comment"><![CDATA[Documentation generates two fields entries with this comment.]]></comment></comments><modifiers><public/></modifiers></field><method id="ClassName" type="String" property="read"><comments><comment tag="comment"><![CDATA[This is defined as a property. It's read value type is a String.]]></comment><comment tag="usage"><![CDATA[<code>trace(CTest.ClassName); // traces value of {@link #_maxPosition} field</code>]]></comment></comments><modifiers><static/></modifiers></method><method id="aProperty" type="String" property="read"><comments><comment tag="comment"><![CDATA[This property will display as read-only as there is no set method defined]]></comment><comment tag="description"><![CDATA[A description is still possible on property access level]]></comment></comments><modifiers><public/></modifiers></method><method id="ClassName" type="Void" property="write"><comments><comment tag="comment"><![CDATA[The read,write types of this property differ.]]></comment><comment tag="usage"><![CDATA[<pre>myTest = new CTest("1","2");
myTest.ClassName = 5552346;</pre>]]></comment></comments><modifiers><static/></modifiers><parameters><parameter index="0" id="id" type="Number"/></parameters></method><constructor id="CTest"><comments><comment tag="comment"><![CDATA[First line is the short description. ]]></comment><comment tag="description"><![CDATA[This is a sample constructor. ]]></comment><comment tag="usage"><![CDATA[<code>myTest = new CTest(p1[, p2]);</code>]]></comment><comment tag="param" id="p1"><![CDATA[Parameter One needs no type information, Order is important.]]></comment><comment tag="param" id="p2"><![CDATA[Parameter Two needs no type information, Order is important.]]></comment><comment tag="deprecated"><![CDATA[Since API 1.3, use {@link #methodOne}]]></comment></comments><modifiers><public/></modifiers><parameters><parameter index="0" id="p1" type="String"/><parameter index="1" id="p2" type="String"/></parameters></constructor><method id="methodOne" type="CTest"><comments><comment tag="comment"><![CDATA[Method with return type and parameters. ]]></comment><comment tag="description"><![CDATA[If this method returns <code>true</code>,  everything is alright. The parameter order of p1, p2 and p3 is random within the documentation and the parameter names have been added.]]></comment><comment tag="usage"><![CDATA[<code>myTest.methodOne(0);</code>]]></comment><comment tag="param" id="p2"><![CDATA[An unused parameter.]]></comment><comment tag="param" id="p3"><![CDATA[This is the third parameter.	]]></comment><comment tag="param" id="p1"><![CDATA[Another unused parameter.]]></comment><comment tag="returns"><![CDATA[A new <code>CTest</code> instance.]]></comment></comments><modifiers><public/></modifiers><parameters><parameter index="0" id="p1" type="Number"/><parameter index="1" id="p2" type="Number"/><parameter index="2" id="p3" type="String"/></parameters></method><method id="methodTwo" type="String"><comments><comment tag="comment"><![CDATA[Method which is excluded from documentation and throws an error. ]]></comment><comment tag="description"><![CDATA[ ]]></comment><comment tag="usage"><![CDATA[<code>myString: String = myTest.methodTwo("Hallo");</code>]]></comment><comment tag="param" id="delim"><![CDATA[A delimiter.]]></comment><comment tag="param" id="p2"><![CDATA[The index into the string]]></comment><comment tag="return"><![CDATA[The string "test".]]></comment><comment tag="see"><![CDATA[#methodOne]]></comment><comment tag="see"><![CDATA[ITest]]></comment><comment tag="see"><![CDATA[#returnOne]]></comment><comment tag="throws"><![CDATA[Error if "new String" did not work.]]></comment></comments><modifiers><public/></modifiers><parameters><parameter index="0" id="delim" type="String"/><parameter index="1" id="p2" type="Number"/></parameters></method><method id="returnOne" type="Number"><comments><comment tag="comment"><![CDATA[Also supported documentation style using // only. ]]></comment><comment tag="author"><![CDATA[Mr. Wind]]></comment><comment tag="version"><![CDATA[1.0.0]]></comment><comment tag="description"><![CDATA[Testing simple // commenting in multiple lines]]></comment><comment tag="usage"><![CDATA[<code>myNumber: Number = myTest.returnOne();</code>]]></comment><comment tag="returns"><![CDATA[Always 1. ]]></comment></comments><modifiers><public/></modifiers></method><method id="implementThisMethod" type="String"><comments><comment tag="comment"><![CDATA[This method implements the ITest interface method and shows comment inheritance]]></comment><comment tag="specifiedby"><![CDATA[{@link com.as2doc.examples.ITest#implementThisMethod implementThisMethod} in interface {@link com.as2doc.examples.ITest}]]></comment><comment tag="description"><![CDATA[Any class which implements this method and is missing comments (@param) which are available in the interface, inherit these in the final documentation.]]></comment><comment tag="param" id="Parameter1"><![CDATA[The first part of the combined string]]></comment><comment tag="param" id="Parameter2"><![CDATA[Converts to a string and gets combined with first parameter]]></comment><comment tag="return"><![CDATA[Returns string combination of both parameters]]></comment></comments><modifiers><public/></modifiers><parameters><parameter index="0" id="Parameter1" type="String"/><parameter index="1" id="Parameter2" type="Object"/></parameters></method></members></class></classes></package></documentation>
