/tags/jsdoc_toolkit-1.4.0/test/data/test.js

  1/**
  2 * @overview This library contains a lot of classes and functions.
  3 * @name Test Library
  4 * @author <a href="mailto:jsmith@company.com">Joe Smith</a>
  5 * @version 	0.1
  6 */
  7 
  8/** 
  9* Gets the current foo 
 10* @param {String} fooId	The unique identifier for the foo.
 11* @param [r]	Recursion level.
 12* @return {Object}	Returns the current foo.
 13* @throws {MalformedFoo} In the case of a fooId not being positve and evenly divisable by 9.
 14*/
 15function getFoo(fooID, r){
 16}
 17
 18/**@constructor*/ function Shape3D(){}
 19	Shape3D.prototype.shrink = function(ratio) {}
 20/**
 21 * @desc This is a library of geometry-related functions.
 22 * 
 23 */
 24 Shape2D /*a two-dimensional shape*/
 25 = {
 26	// Shape.Circle()
 27	/** @ignore */
 28	Circle: function(r, x, y){
 29	},
 30	Rect: "r"+makerect({
 31		callback: function(){
 32			flarp: function(){}
 33		}
 34	}),
 35	Triangle: { /* this is wicked };-) */
 36		/** A triangle with a 90 degree angle.
 37			@constructor
 38			@property {number} angles The angles.
 39			@rating {stars} 3
 40			@deprecated
 41		*/
 42		Right: function(a, b, c)	{
 43		/** The ratio. */
 44		this.ratio = a+b/c;
 45		}
 46	},
 47	/** The constant PI*/
 48	PI: 3.14,
 49	/** @constructor 
 50	* @example
 51    * var myPent = new Polygon(5);
 52    * myPent.addSide(s1);
 53	* @example
 54    * var myHex = new Polygon(5).addSide(s2);
 55	*/
 56	Polygon: function(sides) //how many sides
 57	{
 58		this.addSide = function(newSide) {
 59		}
 60		
 61	}
 62};
 63/**
 64 * A Geo.
 65 *
 66 */
 67Geo = <!-- ignore me
 68{
 69/* flat surface */	Plane:
 70		function 
 71		(
 72		w, // the width of the plane
 73		d  // the depth of the plane
 74		) {
 75		
 76		}
 77
 78}
 79
 80/**The e constant.
 81@type number*/
 82var E = 12345;
 83
 84/** meaning of life?
 85@type integer*/
 86var life = function(n) {return n}(42);
 87
 88// nested constructors
 89/** @constructor */
 90function ShapeFactory() {
 91	/** @constructor */
 92    this.SquareMaker = function(size) {
 93    	/** @constructor */
 94        this.Square = function(s) {
 95        	/** The size. */
 96            this.size = s;
 97            this.display = function() {
 98                alert("square: "+s);
 99            }
100        }
101    }
102}
103