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

http://jsdoc-toolkit.googlecode.com/ · JavaScript · 103 lines · 47 code · 9 blank · 47 comment · 0 complexity · 2ba52a94edf6ce1049677d2bea1105cc MD5 · raw file 

    

  1. /**

    2. 

  2.  * @overview This library contains a lot of classes and functions.

    3. 

  3.  * @name Test Library

    4. 

  4.  * @author <a href="mailto:jsmith@company.com">Joe Smith</a>

    5. 

  5.  * @version 	0.1

    6. 

  6.  */

    7. 

  7.  

    8. 

  8. /** 

    9. 

  9. * Gets the current foo 

    10. 

  10. * @param {String} fooId	The unique identifier for the foo.

    11. 

  11. * @param [r]	Recursion level.

    12. 

  12. * @return {Object}	Returns the current foo.

    13. 

  13. * @throws {MalformedFoo} In the case of a fooId not being positve and evenly divisable by 9.

    14. 

  14. */

    15. 

  15. function getFoo(fooID, r){

    16. 

  16. }

    17. 

  17. 

    18. 

  18. /**@constructor*/ function Shape3D(){}

    19. 

  19. 	Shape3D.prototype.shrink = function(ratio) {}

    20. 

  20. /**

    21. 

  21.  * @desc This is a library of geometry-related functions.

    22. 

  22.  * 

    23. 

  23.  */

    24. 

  24.  Shape2D /*a two-dimensional shape*/

    25. 

  25.  = {

    26. 

  26. 	// Shape.Circle()

    27. 

  27. 	/** @ignore */

    28. 

  28. 	Circle: function(r, x, y){

    29. 

  29. 	},

    30. 

  30. 	Rect: "r"+makerect({

    31. 

  31. 		callback: function(){

    32. 

  32. 			flarp: function(){}

    33. 

  33. 		}

    34. 

  34. 	}),

    35. 

  35. 	Triangle: { /* this is wicked };-) */

    36. 

  36. 		/** A triangle with a 90 degree angle.

    37. 

  37. 			@constructor

    38. 

  38. 			@property {number} angles The angles.

    39. 

  39. 			@rating {stars} 3

    40. 

  40. 			@deprecated

    41. 

  41. 		*/

    42. 

  42. 		Right: function(a, b, c)	{

    43. 

  43. 		/** The ratio. */

    44. 

  44. 		this.ratio = a+b/c;

    45. 

  45. 		}

    46. 

  46. 	},

    47. 

  47. 	/** The constant PI*/

    48. 

  48. 	PI: 3.14,

    49. 

  49. 	/** @constructor 

    50. 

  50. 	* @example

    51. 

  51.     * var myPent = new Polygon(5);

    52. 

  52.     * myPent.addSide(s1);

    53. 

  53. 	* @example

    54. 

  54.     * var myHex = new Polygon(5).addSide(s2);

    55. 

  55. 	*/

    56. 

  56. 	Polygon: function(sides) //how many sides

    57. 

  57. 	{

    58. 

  58. 		this.addSide = function(newSide) {

    59. 

  59. 		}

    60. 

  60. 		

    61. 

  61. 	}

    62. 

  62. };

    63. 

  63. /**

    64. 

  64.  * A Geo.

    65. 

  65.  *

    66. 

  66.  */

    67. 

  67. Geo = <!-- ignore me

    68. 

  68. {

    69. 

  69. /* flat surface */	Plane:

    70. 

  70. 		function 

    71. 

  71. 		(

    72. 

  72. 		w, // the width of the plane

    73. 

  73. 		d  // the depth of the plane

    74. 

  74. 		) {

    75. 

  75. 		

    76. 

  76. 		}

    77. 

  77. 

    78. 

  78. }

    79. 

  79. 

    80. 

  80. /**The e constant.

    81. 

  81. @type number*/

    82. 

  82. var E = 12345;

    83. 

  83. 

    84. 

  84. /** meaning of life?

    85. 

  85. @type integer*/

    86. 

  86. var life = function(n) {return n}(42);

    87. 

  87. 

    88. 

  88. // nested constructors

    89. 

  89. /** @constructor */

    90. 

  90. function ShapeFactory() {

    91. 

  91. 	/** @constructor */

    92. 

  92.     this.SquareMaker = function(size) {

    93. 

  93.     	/** @constructor */

    94. 

  94.         this.Square = function(s) {

    95. 

  95.         	/** The size. */

    96. 

  96.             this.size = s;

    97. 

  97.             this.display = function() {

    98. 

  98.                 alert("square: "+s);

    99. 

  99.             }

    100. 

  100.         }

    101. 

  101.     }

    102. 

  102. }
    103.