LinkExample

Kind of class:	class
Inherits from:	none
Version:	26 December 2006
Author:	Arthur Clemens
Classpath:	LinkExample
File last modified:	Monday, 25 December 2006, 20:57:59

► View source

▼ Hide source

/**
A link in a class description: {@link path.to.ReferencedClass} or here: {@link ReferencedClass#draw}. Or a link to a method in the current class: {@link #draw}.

A written url: http://visiblearea.com/visdoc/ and a html link: <a href="http://visiblearea.com/visdoc/documentation/">http://visiblearea.com/visdoc/documentation/</a>
@author Arthur Clemens
@version 26 December 2006
@use A link in a field: {@link ReferencedClass#paint}.
*/

class LinkExample {
    
    /**
    Testing a link to own class: {@link LinkExample}.
    */
    public function LinkExample ()
    {
    
    }
    
    /**
    A link in a method description: {@link ReferencedClass#paint}.
    @use A link in a method field: {@link ReferencedClass#paint} and another one with link label: {@link ReferencedClass#draw link to method draw}, and another reference that does not exist: {@link ReferencedClass#spray}. Example of @linkplain: {@linkplain ReferencedClass#paint}.
    */
    public function draw (inObject:ReferencedClass) : Void
    {}
    
    /**
    Testing multiple links in method line.
    */
    public function drawnObject (inObject1:ReferencedClass, inObject2:ReferencedClass) : ReferencedClass
    {}
    
}

A link in a class description: path.to.ReferencedClass or here: path.to.ReferencedClass.draw. Or a link to a method in the current class: draw.

A written url: http://visiblearea.com/visdoc/ and a html link: http://visiblearea.com/visdoc/documentation/

Usage:

A link in a field: path.to.ReferencedClass.paint.

Summary

Constructor

LinkExample

Instance methods

draw (inObject:ReferencedClass) : Void
- A link in a method description: path.to.ReferencedClass.paint.
drawnObject (inObject1:ReferencedClass) : ReferencedClass
- Testing multiple links in method line.

Constructor

LinkExample

function LinkExample (

)

Testing a link to own class: LinkExample.

Instance methods

draw

function draw (

inObject:ReferencedClass) : Void

A link in a method description: path.to.ReferencedClass.paint.

Usage:

A link in a method field: path.to.ReferencedClass.paint and another one with link label: link to method draw, and another reference that does not exist: path.to.ReferencedClass.spray. Example of @linkplain: path.to.ReferencedClass.paint.

drawnObject

function drawnObject (

inObject1:ReferencedClass, inObject2:ReferencedClass) : ReferencedClass

Testing multiple links in method line.