From 6fcec0d9b636c24c3c7370addc1b3359f8f73393 Mon Sep 17 00:00:00 2001 From: Yaski Date: Thu, 12 Jul 2012 21:42:49 +0600 Subject: [PATCH] Maven asdoc output --- pom.xml | 43 +++++++++++++++++++ .../engine3d/animation/AnimationController.as | 2 +- .../engine3d/animation/AnimationNotify.as | 10 +++-- src/alternativa/engine3d/objects/Decal.as | 8 ++-- .../engine3d/resources/Geometry.as | 13 +++--- .../shadows/DirectionalLightShadow.as | 4 +- 6 files changed, 64 insertions(+), 16 deletions(-) diff --git a/pom.xml b/pom.xml index a8c15ac..0e35ff7 100644 --- a/pom.xml +++ b/pom.xml @@ -14,6 +14,49 @@ scm:git:git@github.com:AlternativaPlatform/Alternativa3D.git scm:git:git@github.com:AlternativaPlatform/Alternativa3D.git + + + + fast + + + + org.sonatype.flexmojos + flexmojos-maven-plugin + + + install + + asdoc + + + + + + org.apache.maven.plugins + maven-antrun-plugin + 1.6 + + + archive + install + + run + + + + + + + + + + + + + + + diff --git a/src/alternativa/engine3d/animation/AnimationController.as b/src/alternativa/engine3d/animation/AnimationController.as index f22fe64..f98eadc 100644 --- a/src/alternativa/engine3d/animation/AnimationController.as +++ b/src/alternativa/engine3d/animation/AnimationController.as @@ -209,7 +209,7 @@ package alternativa.engine3d.animation { } /** - * Freezes internal time counter till the next update() call. + * Freezes internal time counter till the next update() call. * * @see #update */ diff --git a/src/alternativa/engine3d/animation/AnimationNotify.as b/src/alternativa/engine3d/animation/AnimationNotify.as index ead820b..96ac2ec 100644 --- a/src/alternativa/engine3d/animation/AnimationNotify.as +++ b/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. - * AnimationNotify instance subscribes to NotifyEvent.When animation - * playback reaches the given time, an event is dispatched by the trigger. + * AnimationNotify instance subscribes to NotifyEvent.NOTIFY + * When animation playback reaches the given time, an event is dispatched by the trigger. * - * + * @example The following code listens event when 30 seconds elapsed from animation start: + * * animationClip.addNotify(30).addEventListener(NotifyEvent.NOTIFY, notifyHandler) * … * private function notifyHandler(e:NotifyEvent):void{ * trace("Animation time is " + e.notify.time + " seconds now") - *} + *} + * * * * @see AnimationClip#addNotify() diff --git a/src/alternativa/engine3d/objects/Decal.as b/src/alternativa/engine3d/objects/Decal.as index 017248b..db6d64b 100644 --- a/src/alternativa/engine3d/objects/Decal.as +++ b/src/alternativa/engine3d/objects/Decal.as @@ -22,14 +22,16 @@ package alternativa.engine3d.objects { /** * A Mesh which has z-fighting engine. Most popular case of use is for dynamic addition of different tracks over existing surfaces. * The Plane instance can be used as the geometry source. - * + * + * @example The following code creates decal from plane: + * * 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 < plane.numSurfaces; i++){ * decal.addSurface(null, plane.getSurface(i).indexBegin, plane.getSurface(i).numTriangles);} * decal.geometry.upload(stage3D.context3D); - * + * */ public class Decal extends Mesh { diff --git a/src/alternativa/engine3d/resources/Geometry.as b/src/alternativa/engine3d/resources/Geometry.as index 6e29d75..5e98e78 100644 --- a/src/alternativa/engine3d/resources/Geometry.as +++ b/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. * * 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 [x1,y1,z1,x2,y2,z2,x3,y3,z3]); - * geometry.setAttributeValues(VertexAttributes.TEXCOORDS[0], new [u1,v1,u2,v2,u3,v3]); - * geometry.indices = Vector.([0,1,2]); + * geometry.setAttributeValues(VertexAttributes.POSITION, new <Number>[x1,y1,z1,x2,y2,z2,x3,y3,z3]); + * geometry.setAttributeValues(VertexAttributes.TEXCOORDS[0], new <Number>[u1,v1,u2,v2,u3,v3]); + * geometry.indices = Vector.<uint>([0,1,2]); * * To get access to data, you can use method getAttributeValues by parameter name, e.g.: * geometry.getAttributeValues(VertexAttributes.POSITION) - * returns vector from coordinates: [x1,y1,z1,x2,y2,z2,x3,y3,z3]. + * returns vector from coordinates: <Number>[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: Vector.([vertex_id_1,vertex_id_2,vertex_id_3,vertex_id_4,vertex_id_5,vertex_id_6]);. + * Example of specifying of surface, that consists of two triangles: Vector.<uint>([vertex_id_1,vertex_id_2,vertex_id_3,vertex_id_4,vertex_id_5,vertex_id_6]);. */ public function get indices():Vector. { return _indices.slice(); diff --git a/src/alternativa/engine3d/shadows/DirectionalLightShadow.as b/src/alternativa/engine3d/shadows/DirectionalLightShadow.as index 154a6be..4c11eb0 100644 --- a/src/alternativa/engine3d/shadows/DirectionalLightShadow.as +++ b/src/alternativa/engine3d/shadows/DirectionalLightShadow.as @@ -117,7 +117,7 @@ package alternativa.engine3d.shadows { * casting place is coded by pixel color. So, properties nearBoundPosition * and farBoundPosition in some ways are analogues of Camera3D.farClipping * and Camera3D.nearclipping. The greater the range between nearBoundPosition - * and farBoundPosition , the rougher the coordinates of the pixel shader + * and farBoundPosition , 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: centerX, * centerY, centerZ. @@ -133,7 +133,7 @@ package alternativa.engine3d.shadows { * casting place is coded by pixel color. So, properties nearBoundPosition * and farBoundPosition in some ways are analogues of Camera3D.farClipping * and Camera3D.nearclipping. The greater the range between nearBoundPosition - * and farBoundPosition , the rougher the coordinates of the pixel shader + * and farBoundPosition , 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 centerX, * centerY, centerZ.