Maven asdoc output

pom.xml

@@ -14,6 +14,49 @@
 		<url>scm:git:git@github.com:AlternativaPlatform/Alternativa3D.git</url>
 		<developerConnection>scm:git:git@github.com:AlternativaPlatform/Alternativa3D.git</developerConnection>
 	</scm>
+
+	<profiles>
+		<profile>
+			<id>fast</id>
+			<build>
+				<plugins>
+					<plugin>
+						<groupId>org.sonatype.flexmojos</groupId>
+						<artifactId>flexmojos-maven-plugin</artifactId>
+						<executions>
+							<execution>
+								<phase>install</phase>
+								<goals>
+									<goal>asdoc</goal>
+								</goals>
+							</execution>
+						</executions>
+					</plugin>
+					<plugin>
+						<groupId>org.apache.maven.plugins</groupId>
+						<artifactId>maven-antrun-plugin</artifactId>
+						<version>1.6</version>
+						<executions>
+							<execution>
+								<id>archive</id>
+								<phase>install</phase>
+								<goals>
+									<goal>run</goal>
+								</goals>
+								<configuration>
+									<target>
+										<zip destfile="${basedir}/target/target/asdoc_en.zip" basedir="${basedir}/target/asdoc" />
+										<copy file="${basedir}/target/${project.artifactId}-${project.version}.swc" tofile="${basedir}/target/target/Alternativa3D.swc" />
+									</target>
+								</configuration>
+							</execution>
+						</executions>
+					</plugin>
+				</plugins>
+			</build>
+		</profile>
+	</profiles>
+
 	<dependencyManagement>
 		<dependencies>
 			<dependency>

src/alternativa/engine3d/animation/AnimationController.as

@@ -209,7 +209,7 @@ package alternativa.engine3d.animation {
 		}
 
 		/**
-		 * Freezes internal time counter till the next <code>update()<code> call.
+		 * Freezes internal time counter till the next <code>update()</code> call.
 		 * 
 		 * @see #update
 		 */

src/alternativa/engine3d/animation/AnimationNotify.as

@@ -16,15 +16,17 @@ package alternativa.engine3d.animation {
 
 	/**
 	 * The notification trigger bound to certain time on an animation time line.
-	 * <code>AnimationNotify</code> instance subscribes to <code>NotifyEvent.<NOTIFY /code>When animation
+	 * <code>AnimationNotify</code> instance subscribes to <code>NotifyEvent.NOTIFY</code>
-	 * playback reaches the given time, an event is dispatched by the trigger.
+	 * When animation playback reaches the given time, an event is dispatched by the trigger.
 	 *
-     *<code>
+	 * @example The following code listens event when 30 seconds elapsed from animation start:
+     * <listing version="3.0">
      * animationClip.addNotify(30).addEventListener(NotifyEvent.NOTIFY, notifyHandler)
      * …
      * private function notifyHandler(e:NotifyEvent):void{
      *  trace("Animation time is " + e.notify.time + " seconds now")
-     *}</code>
+     *}
+	 * </listing>
      *
 	 * 
 	 * @see AnimationClip#addNotify()

src/alternativa/engine3d/objects/Decal.as

@@ -22,14 +22,16 @@ package alternativa.engine3d.objects {
 	/**
 	 *  A  <code>Mesh</code> which has z-fighting engine. Most popular case of use is for dynamic addition of different tracks over existing surfaces.
 	 *  The <code>Plane</code> instance  can be used as the geometry source.
-     *  <listing version="3.0">
+	 *
+	 * @example The following code creates decal from plane:
+     * <listing version="3.0">
      *       var plane = new Plane(200, 200);
      *       var decal = new Decal();
      *       decal.geometry = plane.geometry;
-     *       for (var i:int = 0; i < plane.numSurfaces; i++){
+     *       for (var i:int = 0; i &lt; plane.numSurfaces; i++){
      *       decal.addSurface(null, plane.getSurface(i).indexBegin, plane.getSurface(i).numTriangles);}
      *       decal.geometry.upload(stage3D.context3D);
-     *        </listing>
+     * </listing>
 	 */
 	public class Decal extends Mesh {
 

src/alternativa/engine3d/resources/Geometry.as

@@ -15,7 +15,7 @@ package alternativa.engine3d.resources {
 	import alternativa.engine3d.core.Transform3D;
 	import alternativa.engine3d.core.VertexAttributes;
 	import alternativa.engine3d.core.VertexStream;
-	
+
 	import flash.display3D.Context3D;
 	import flash.display3D.IndexBuffer3D;
 	import flash.display3D.VertexBuffer3D;
@@ -32,6 +32,7 @@ package alternativa.engine3d.resources {
 	 * memory of GPU, independently of each other (vertexBuffer  can be updated at once only).
 	 * For this, you can store groups of parameters in different streams. Based on them vertexBuffers will be formed on uploading to GPU.
 	 * When new stream is formed, are specified the parameters, that will be stored in it.
+	 *
 	 * @example This code creates stream on properties: x,y,z,u,v and forms a triangle by three vertices.
 	 * <listing version="3.0">
 	 * var attributes:Array = new Array();
@@ -43,13 +44,13 @@ package alternativa.engine3d.resources {
 	 * var geometry = new Geometry();
 	 * geometry.addVertexStream(attributes);
 	 * geometry.numVertices = 3;
-	 * geometry.setAttributeValues(VertexAttributes.POSITION, new <Number>[x1,y1,z1,x2,y2,z2,x3,y3,z3]);
+	 * geometry.setAttributeValues(VertexAttributes.POSITION, new &lt;Number&gt;[x1,y1,z1,x2,y2,z2,x3,y3,z3]);
-	 * geometry.setAttributeValues(VertexAttributes.TEXCOORDS[0], new <Number>[u1,v1,u2,v2,u3,v3]);
+	 * geometry.setAttributeValues(VertexAttributes.TEXCOORDS[0], new &lt;Number&gt;[u1,v1,u2,v2,u3,v3]);
-	 * geometry.indices = Vector.<uint>([0,1,2]);
+	 * geometry.indices = Vector.&lt;uint&gt;([0,1,2]);
 	 * </listing>
 	 * To get access to data, you can use method <code>getAttributeValues</code> by parameter name, e.g.:
 	 * <code>geometry.getAttributeValues(VertexAttributes.POSITION)</code>
-	 * returns vector from coordinates: <Number>[x1,y1,z1,x2,y2,z2,x3,y3,z3].
+	 * returns vector from coordinates: &lt;Number&gt;[x1,y1,z1,x2,y2,z2,x3,y3,z3].
 	 */
 	public class Geometry extends Resource {
 
@@ -102,7 +103,7 @@ package alternativa.engine3d.resources {
 
 		/**
 		 * Indexes of vertices for specifying of triangles of surface.
-		 * Example of specifying of surface, that consists of two triangles: <code> Vector.<uint>([vertex_id_1,vertex_id_2,vertex_id_3,vertex_id_4,vertex_id_5,vertex_id_6]);</code>.
+		 * Example of specifying of surface, that consists of two triangles: <code> Vector.&lt;uint&gt;([vertex_id_1,vertex_id_2,vertex_id_3,vertex_id_4,vertex_id_5,vertex_id_6]);</code>.
 		 */
 		public function get indices():Vector.<uint> {
 			return _indices.slice();

src/alternativa/engine3d/shadows/DirectionalLightShadow.as

@@ -117,7 +117,7 @@ package alternativa.engine3d.shadows {
 		 * casting place is coded by pixel color. So, properties <code>nearBoundPosition</code>
 		 * and <code>farBoundPosition</code> in some ways are analogues of <code>Camera3D.farClipping</code>
 		 * and <code>Camera3D.nearclipping</code>. The greater the range between <code>nearBoundPosition</code>
-		 * and <code> farBoundPosition </ code>, the rougher the coordinates of the pixel shader
+		 * and <code> farBoundPosition </code>, the rougher the coordinates of the pixel shader
 		 * will be determined. Shadow area, that is not included into this range would not be drawn.
 		 * Value is measured from center of shadow, that is set by properties: <code>centerX</code>,
 		 * <code>centerY</code>, <code>centerZ</code>.
@@ -133,7 +133,7 @@ package alternativa.engine3d.shadows {
 		 * casting place is coded by pixel color. So, properties <code>nearBoundPosition</code>
 		 * and <code>farBoundPosition</code> in some ways are analogues of <code>Camera3D.farClipping</code>
 		 * and <code>Camera3D.nearclipping</code>. The greater the range between <code>nearBoundPosition</code>
-		 * and <code> farBoundPosition </ code>, the rougher the coordinates of the pixel shader
+		 * and <code> farBoundPosition </code>, the rougher the coordinates of the pixel shader
 		 * will be determined. Shadow area, that is not included into this range would not be drawn.
 		 * Value is measured from center of shadow, that is set by properties <code>centerX</code>,
 		 * <code>centerY</code>, <code>centerZ</code>.