×Hide private members
+Show private members

AllTags

Kind of class:	class
Inherits from:	none
Version:	22 Mar 2005, 1.2 18 June 2005, 2.0 5 December 2005, 3.0 26 December 2006
Author:	Arthur Clemens, Some Other Author
Classpath:	AllTags
File last modified:	Sunday, 02 March 2008, 17:03:49

► View source

▼ Hide source

/**
The first sentence of the class description is the class summary, according to the Javadoc specification at http://java.sun.com/j2se/javadoc/index.jsp. The first sentence ends with a period or with a HTML block element ({@code address, blockquote, br, center, del, div, h, hr, ins, li, ol, p, table, td, th, tr, ul}). In VisDoc, like Javadoc, the summary is printed in bold.
@description The summary list shows the original class file order of methods and properties. The method and propery descriptions are shown alphabetically.

To show an image, write <code>{</code><code>@img img_name}</code>. Images are placed in the folder <code>img/</code>.

Example: <code>{</code><code>@img movie_management_glance.png}</code> results in:

{@img movie_management_glance.png}

Other custom VisDoc tags are:
<code>@</code><code>description</code><br />
<code>@</code><code>example</code><br />
<code>@</code><code>img</code><br />
<code>@</code><code>returns</code><br />
<code>@</code><code>usage</code><br />
<code>@</code><code>use</code><br />
<code>@</code><code>exclude</code><br />
<code>@</code><code>history</code><br />
<code>@</code><code>implementationNote</code><br />
<code>@</code><code>overload</code><br />
<code>@</code><code>sends</code><br />
<code>@</code><code>todo</code><br />
<code>@</code><code>usageNote</code>

Read http://visiblearea.com/visdoc/documentation/ how to use these tags.

@author Arthur Clemens
@author Some Other Author
@version 22 Mar 2005
@version 1.2 18 June 2005
@version 2.0 5 December 2005
@version 3.0 26 December 2006
*/
[Event("click")]
[InspectableList("property_D","property_E")]
class AllTags {
    
    public var count:Number; /**< Example of right side javadoc. */
    
    /**
    Demonstrating exclude with property. This example property does not have a 'private'
    access set, but really should not be used externally.
    @exclude
    */
    var __some__;
    
    [Inspectable("danger", 1, true, maybe)]
    [Inspectable(name="Background Colour",type="Color",defaultValue="#CCCC99")]
    var bgcolour:Number = 0xCCCC99;

    function AllTags () 
    {}
    
    /**
    Example of <b>supported</b> Javadoc tags. Inline tags: <b>@code:</b> {@code I can use <html> inside here <hr>}, <b>@inheritDoc</b>, <b>@link:</b> {@link #method_A link to method A}, <b>@literal:</b> {@literal I can use <html> inside here and even 


some newlines}.
    @param inValue The amount of force
    @return Successful or not: true or false.
    @throws IOException If an input or output exception occurred
    @exception ExceptionName Synonym of throws
    @see ReferencedClass
    @see ReferencedClass#draw
    @see ReferencedClass#draw Drawing method
    @since 0.9
     @deprecated As of JDK 1.1., see {@link #method_D}.
     */
    function method_B (inValue:Number) : Boolean 
    {}
    
    /**
    Test when no explanation is given with the deprecated tag.
     @deprecated
     */
    function method_BB (inValue:Number) : Boolean 
    {}
    
    /**
    Example of <b>unsupported</b> Javadoc tags.
    @docRoot (not implemented)
     @serial (not applicable for AS)
     @serialData (not applicable for AS)
     @serialField (not applicable for AS)
     @value (not implemented)
    */
    function method_A (inValue:Number) : Boolean 
    {}
    
    /**
    @private
    Example of FlashDoc tag <b>@private</b>: text that is added below the tag is added to the description.
    */
    public function method_C () : Void
    {}
    
    /**
    Example of <b>commonly used</b> tags.
    @description Some explicitly stated description.
     @example To give a code example - <code>code example</code>
     @example Code example two: <code>code example</code>
    @returns @returns creates the same header "Returns" as @return.
    @use <code>Code example on one line</code>, or a block of code:
     <code>
     var myObj = new MyClass();
     myObj.someFunction(1);
     </code>
     @usage @usage creates the same header "Usage" as @use.
    */
    function method_D (o:Object) : Void 
    {}
    
    /**
    Example of <b>other useful</b> tags.
    @overload #method_C
    @sends onChanged(changedField:TextField):Void # When the selection is changed by the user.
     @implementationNote This method invokes <code>setInterval</code>.
     @usageNote @usageNote adds a note to the @use example. For example: Do not forget to store the return value for later use.
     @history 3 July 2004: changed order of execution
     @history 1 Feb 2004: fixed small bug in date calculation
      @history 1 Jan 2004: first release
     @todo Something left to do...
    */
    function method_E (inValue:Number) : Boolean 
    {}
    
    /**
    Demonstrating exclude with method.
    @exclude
    */
    function method_F (inValue:Number) : Boolean 
    {}
    
    /**
    Demonstrating a private method (with the option "List private methods")
    */
    private function method_G () : Void
    {}

    /**
    An event handler.
    */
    public function onData () : Void
    {}
    
    /**
    A static method.
    */
    public static function send (inMessage:String) : Void
    {}
    
    /**
    * Real world getter example from Accordion.as
    * @tiptext Specifies the index of the child view that is currently displayed
    * @helpid 3402
    */
    [Bindable]
    [ChangeEvent("change")]
    function get selectedIndex():Number
    {
        return getSelectedIndex();
    }
}

The first sentence of the class description is the class summary, according to the Javadoc specification at http://java.sun.com/j2se/javadoc/index.jsp. The first sentence ends with a period or with a HTML block element (address, blockquote, br, center, del, div, h, hr, ins, li, ol, p, table, td, th, tr, ul). In VisDoc, like Javadoc, the summary is printed in bold.
The summary list shows the original class file order of methods and properties. The method and propery descriptions are shown alphabetically.

To show an image, write {@img img_name}. Images are placed in the folder img/.

Example: {@img movie_management_glance.png} results in:

Other custom VisDoc tags are:description
example
img
returns
usage
use
exclude
history
implementationNote
overload
sends
todo
@usageNote
Read http://visiblearea.com/visdoc/documentation/ how to use these tags.

Events broadcasted to listeners:

onChanged(changedField:TextField):Void When the selection is changed by the user.

Component metadata:

Event	"click"

Summary

Constructor

AllTags

Instance properties

count : Number
- Example of right side javadoc.
bgcolour : Number
selectedIndex : Number
- Real world getter example from Accordion.as

Class methods

send (inMessage:String) : Void
- A static method.

Instance methods

method_B (inValue:Number) : Boolean
- Example of supported Javadoc tags.
method_BB (inValue:Number) : Boolean
- Test when no explanation is given with the deprecated tag.
method_A (inValue:Number) : Boolean
- Example of unsupported Javadoc tags.
method_C : Void
method_D (o:Object) : Void
- Example of commonly used tags.
method_E (inValue:Number) : Boolean
- Example of other useful tags.
method_G : Void
- Demonstrating a private method (with the option "List private methods")

Event handlers

onData : Void
- An event handler.

Constructor

AllTags

function AllTags (

)

Instance properties

bgcolour

bgcolour:Number = 0xCCCC99

(read)

Component metadata:

Inspectable	"#CCCC99" "Color",defaultValue "danger", 1, maybe true, name: "Background Colour",type

count

count:Number

(read)

Example of right side javadoc.

selectedIndex

selectedIndex:Number

(read)

Real world getter example from Accordion.as

Component metadata:

Bindable
ChangeEvent	"change"

Class methods

send

static function send (

inMessage:String) : Void

A static method.

Instance methods

method_A

function method_A (

inValue:Number) : Boolean

Example of unsupported Javadoc tags.

docroot:

(not implemented)

serial:

(not applicable for AS)

serialData:

(not applicable for AS)

serialField:

(not applicable for AS)

value:

(not implemented)

method_B

function method_B (

inValue:Number) : Boolean

Deprecated As of JDK 1.1., see method_D.

Example of supported Javadoc tags. Inline tags: @code: I can use <html> inside here <hr>, @inheritDoc, @link: link to method A, @literal: I can use <html> inside here and even

some newlines.

Parameters:

inValue:

The amount of force

Returns:

Successful or not: true or false.

Throws:

IOException If an input or output exception occurred

Exception:

ExceptionName Synonym of throws

method_BB

function method_BB (

inValue:Number) : Boolean

Deprecated

Test when no explanation is given with the deprecated tag.

method_C

public function method_C (

) : Void

method_D

function method_D (

o:Object) : Void

Example of commonly used tags. Some explicitly stated description.

Example:

To give a code example - code example
Code example two: code example

Returns:

@returns creates the same header "Returns" as @return.

Usage:

Code example on one line, or a block of code:

var myObj = new MyClass();
myObj.someFunction(1);

Usage:

@usage creates the same header "Usage" as @use.

method_E

function method_E (

inValue:Number) : Boolean

Example of other useful tags.

Overloading:

method_C () : Void

Events broadcasted to listeners:

onChanged(changedField:TextField):Void When the selection is changed by the user.

Implementation note:

This method invokes setInterval.

Usage note:

@usageNote adds a note to the @use example. For example: Do not forget to store the return value for later use.

Version history:

3 July 2004: changed order of execution
1 Feb 2004: fixed small bug in date calculation
1 Jan 2004: first release

To do:

Something left to do...

method_G

private function method_G (

) : Void

Demonstrating a private method (with the option "List private methods")

Event handlers

onData

function onData (

) : Void

An event handler.