archive-gh-me/jsdoc
1
0
Fork 0
mirror of https://github.com/jsdoc/jsdoc.git synced 2025-12-08 19:46:11 +00:00
Code Issues Projects Releases Wiki Activity

Clean up of test folder -- removing old samples dir.

Browse Source
This commit is contained in:
Michael Mathews 2011-01-22 23:37:53 +00:00
parent afe2b90e1f
commit 9a4a23d329
30 changed files with 0 additions and 1108 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
test/samples/etc_e4x.js
View File

@ -1,10 +0,0 @@
/** @var */
var exampleDocs = <>
<example>/** @function */ function foo(){}</example>
<example>/** @var */ var x = 1;</example>
</>;
/** @function */
function show() {
alert(example.length()); // shows 2
}

52
test/samples/etc_requirejs.js
View File

@ -1,52 +0,0 @@
/**
* @module ./webui/utils.strings
*/
define('./webui/utils.strings',
function() {
var strings = {};
/** @method module:"./webui/utils.strings".twiddle */
strings.twiddle = function() {
}
return strings;
}
);
/**
* Interactive graphical user elements.
* @module ui/widget
* @requires module:"./webui/utils.strings"
*/
define('ui/widget',
['./webui/utils.strings'],
function(strings) {
return {
/**
* Initialise the widget.
* @method module:ui/widget.init
*/
init: function() {
}
};
}
);
/**
* Interactive graphical user elements.
* @module ui/Kaleidoscope
* @requires module:ui/widget
* @requires module:"./webui/utils.strings"
*/
define('ui/Kaleidoscope',
['ui/widget', './webui/utils.strings'],
function(w, s) {
return {
/**
* @memberof module:ui/Kaleidoscope
*/
twirl: function() {
}
};
}
);

10
test/samples/jsdoc_file.js
View File

@ -1,10 +0,0 @@
/*
blah
*/
/** @function foo */

42
test/samples/jsdoc_infermethod.js
View File

@ -1,42 +0,0 @@
// /** A function that does stuff. */
// function doStuff() {
// }
//
// /**
// * Shape is an abstract base class. It is defined simply
// * to have something to inherit from for geometric
// * subclasses
// * @constructor
// */
// function Shape(color){
// this.color = color;
// }
//
// /**
// * Get the name of the color for this shape
// * @returns A color string for this shape
// */
// Shape.prototype.getColor = function() {
// return this.color;
// }
//
// var x,
// /** @return {number} */
// getx = function(){},
// y;
//
ShapeFactory.prototype = {
util: {
/**
* Creates a new {@link Shape} instance.
* @return A new {@link Shape}
* @type Shape
*/
createShape: function() {
/** Track the most recent shape created. */
this.lastShape = new Shape();
return this.lastShape;
}
}
}

17
test/samples/jsdoc_inferobject.js
View File

@ -1,17 +0,0 @@
var util = {
/** @constructor util */
init: function() {
},
/** Remove whitespace padding.
@instance
@param {string} str
*/
trim: function (str) {
}
};
makeClass( 'util', util );

37
test/samples/jsdoc_inner.js
View File

@ -1,37 +0,0 @@
/**
* Construct a new Shape object.
* @class This is the basic Shape class.
* It can be considered an abstract class, even though no such thing
* really existing in JavaScript
* @constructor
* @throws {MemoryException} If there is no more memory
* @throws GeneralShapeException rarely (if ever)
* @return {Shape|Coordinate} A new shape.
*/
function Shape(){
/**
* This is an example of a function that is not given as a property
* of a prototype, but instead it is assigned within a constructor.
* For inner functions like this to be picked up by the parser, the
* function that acts as a constructor <b>must</b> be denoted with
* the <b>&#64;constructor</b> tag in its comment.
* @method
* @returns {String}
*/
this.getClassName = function(){
return "Shape";
}
/**
* This is an inner method, just used here as an example
* @method Shape~addReference
* @private
* @since version 0.5
* @author Sue Smart
*/
function addReference(){
// Do nothing...
}
}

17
test/samples/jsdoc_quotename.js
View File

@ -1,17 +0,0 @@
/**
@namespace
@name chat."#channel"
*/
chat["#channel"] = {};
/**
@property
@type {boolean}
@name chat."#channel".open
*/
chat["#channel"].open = true;
/**
@event chat."#channel"."op:announce-motd"
*/

52
test/samples/jsdoc_resolvefunc.js
View File

@ -1,52 +0,0 @@
// undocumented
ShapeFactory.prototype = {
// undocumented
util: {
// resolves to: @method ShapeFactory#util.createShape
/**
* Creates a new {@link Shape} instance.
* @return A new {@link Shape}
* @type Shape
*/
createShape: function() {
// resolves to: @property ShapeFactory#util.lastShape
/** Track the most recent shape created. */
this.lastShape = new Shape();
return this.lastShape;
}
}
}
// undocumented
foo = function() {
// resolves to: @property g
/** @type {number} */
this.g = 1;
}
/** @constructor */
Foo = function() {
// resolves to: @method Foo#bar
/** two bar */
this.bar = function(){};
// resolves to: @method Foo~inner
/** an inner function */
function inner() {
// resolves to: @method Foo~inner~deep
/** an nested inner function */
function deep() {
// resolves to: @property globalProp
/** set a property */
this.globalProp = 1;
}
}
}
// resolves to: @method globalFunction
/** a global function */
this.globalFunc = function() {
}

13
test/samples/jsdoc_resolvefunc_2.js
View File

@ -1,13 +0,0 @@
/** @namespace */
ns = {};
(function() {
/** @inner
@constructor
@memberOf ns
*/
function foo(s) {
}
})();

46
test/samples/jsdoc_resolvevar.js
View File

@ -1,46 +0,0 @@
// undocumented
this.globalprop = {
/** a child property */
child1: {
/** a nested child func */
child2: {} // globalprop.child1.child2
}
};
(function ($) {
var io = {
/** @property */
ip: function(){} // [[anonymous]]~io.ip
}
})(mylib);
var go = {
/** @var */
gp: true // go.gp
};
/** @var */
var foo,
/** @var */
bar;
// undocumented
function globalFunc() {
/** an inner property */
var innerProp = 1; // globalFunc~innerProp
// undocumented inner function
var innerFunc = function() {
/** a nested child prop */
var nestedProp = 1; // globalFunc~innerFunc~nestedProp
}
}
var ns = {
func: function() {
/** setting prop on objectlit */
this.prop = 1
}
}

542
test/samples/jsdoc_test.js
View File

@ -1,542 +0,0 @@
/**
* @fileoverview This file is to be used for testing the JSDoc parser.
* It is not intended to be an example of good JavaScript OO-programming,
* nor is it intended to fulfill any specific purpose apart from
* demonstrating the functionality of the
* <a href='http://sourceforge.net/projects/jsdoc'>JSDoc</a> parser
*
* @author Michael Mathews micmath@gmail.com
* @author Gabriel Reid gab_reid@users.sourceforge.net
* @version 0.1
*/
/***************************
* This is not
* a jsdoc comment.
****************************/
var errors = [];
/**
Overall namespace object for this library.
@public
@namespace geometry
*/
geometry = {};
/**
Handy utility functions related to geometry.
@namespace geometry.util
*/
geometry.util = {
/** Determine if 2 shapes intersect.
@returns {boolean} True if they do intersect.
*/
intersects: function(shape1, shape2) {
}
};
/**
* @class This class exists to demonstrate the assignment of a class prototype
* as an anonymous block.
*/
geometry.util.ShapeFactory = function(){
}
geometry.util.ShapeFactory.prototype = {
/**
* Creates a new {@link geometry.Shape} instance.
* @param {!Object=} opts An options object that is optional but can't be null.
* @return A new {@link geometry.Shape}
* @type geometry.Shape
*/
createShape: function(opts){
return new geometry.Shape();
}
}
/**
* Construct a new Shape object.
* @class This is the basic Shape class.
* It can be considered an abstract class, even though no such thing
* really existing in JavaScript
* @borrows threeD
* @param {Object} template
* @throws {MemoryException} If there is no more memory
* @throws GeneralShapeException rarely (if ever)
* @return {geometry.Shape|geometry.Coordinate} A new shape.
*/
geometry.Shape = function(template){
/**
* This is an example of a function that is a `this` property.
* Not of a prototype, instead it is assigned within a constructor.
* For inner functions like this to be picked up by the parser, the
* function that acts as a constructor *must* be denoted with
* the `@constructor` tag in its comment.
* @method
* @returns {String}
*/
this.getClassName = function(){
return "geometry.Shape";
}
/**
* This is an inner method, just used here as an example.
* @private
* @since version 0.5
* @author Sue Smart
*/
function addReference(){
// Do nothing...
}
}
/**
* Create a new Hexagon instance.
* @extends geometry.Shape
* @class Hexagon is a class that is a <i>logical</i> sublcass of
* {@link Shape} (thanks to the <code>&#64;extends</code> tag), but in
* reality it is completely unrelated to Shape.
* @param {int} sideLength The length of one side for the new Hexagon
* @example
* var h = new geometry.Hexagon(2);
* @example
* if (hasHex) {
* hex = new geometry.Hexagon(5);
* color = hex.getColor();
* }
*/
geometry.Hexagon = function(sideLength) {
}
/**
* This is a global function that adds two integers together using {@link geometry.Shape#getClassName}.
* @function
* @param {int|string} oneNumber The first number to add
* @param {int|string} twoNumber The second number to add
* @author Gabriel Reid
* @deprecated So you shouldn't use it anymore! Use {@link geometry.Shape#getClassName} instead.
*/
function Add(oneNumber, twoNumber){
return oneNumber + twoNumber;
}
/**
* The color of this shape.
* @property
* @type {string|Color}
*/
geometry.Shape.prototype.color = null;
/**
* The border of this shape.
* @field
* @type {int}
*/
geometry.Shape.prototype.border = function(){return border;};
/*
* These are all the instance method implementations for Shape
*/
/**
* Get the coordinates of this shape. It is assumed that we're always talking
* about shapes in a 2D location here.
* @method
* @requires The {@link geometry.Shape} class
* @returns A Coordinate object representing the location of this Shape
* @type geometry.Coordinate[]
*/
geometry.Shape.prototype.getCoords = function(){
return this.coords;
}
/**
* Get the color of this shape.
* @method
* @see #setColor
* @see The <a href="http://example.com">Color</a> library.
* @link geometry.Shape
* @type Color
*/
geometry.Shape.prototype.getColor = function(){
return this.color;
}
/**
* Set the coordinates for this Shape
* @method
* @param {geometry.Coordinate} coordinates The coordinates to set for this Shape
*/
geometry.Shape.prototype.setCoords = function(coordinates){
this.coords = coordinates;
}
/**
* Set the color for this Shape
* @method
* @param {?Color} [color=black] The color to set for this Shape
* @param other There is no other param, but it can still be documented if
* optional parameters are used
* @throws NonExistantColorException (no, not really!)
* @see #getColor
*/
geometry.Shape.prototype.setColor = function(color){
this.color = color || new Color(0, 0, 0);
}
/**
* Clone this shape.
* @method
* @returns A copy of this shape
* @type geometry.Shape
* @author Gabriel Reid
*/
geometry.Shape.prototype.clone = function(){
return new geometry.Shape();
}
/**
* Create a new Rectangle instance.
* @class A basic rectangle class, inherits from Shape.
* This class could be considered a concrete implementation class
* @constructor
* @param {int} width The optional width for this Rectangle
* @param {int} height Thie optional height for this Rectangle
* @author Gabriel Reid
* @see geometry.Shape is the base class for this
* @extends geometry.Shape
* @hilited
*/
geometry.Rectangle = function(width, // This is the width
height // This is the height
){
if (width){
this.width = width;
if (height){
this.height = height;
}
}
}
/* Inherit from Shape */
geometry.Rectangle.prototype = new geometry.Shape();
/**
* Value to represent the width of the Rectangle.
* <br>Text in <b>bold</b> and <i>italic</i> and a
* link to <a href="http://sf.net">SourceForge</a>
* @private
* @type int
*/
geometry.Rectangle.prototype._width = 0;
/**
* Value to represent the height of the Rectangle.
* @private
* @type int
*/
geometry.Rectangle.prototype._height = 0;
/**
* Get the type of this object.
* @type String
*/
geometry.Rectangle.prototype.getClassName= function(){
return "Rectangle";
}
/**
* Get the value of the width for the Rectangle.
* @type int
* @see geometry.Rectangle#setWidth
*/
geometry.Rectangle.prototype.getWidth = function(){
return this.width;
}
/**
* Get the value of the height for the Rectangle.
* Another getter is the {@link geometry.Shape#getColor} method in the
* {@link geometry.Shape} base class.
* @return The height of this Rectangle
* @type int
* @see Rectangle#setHeight
*/
geometry.Rectangle.prototype.getHeight = function(){
return this.height;
}
/**
* Set the width value for this Rectangle.
* @param {int} width The width value to be set
* @see #setWidth
*/
geometry.Rectangle.prototype.setWidth = function(width){
this.width = width;
}
/**
* Set the height value for this Rectangle.
* @param {int} height The height value to be set
* @see #getHeight
*/
geometry.Rectangle.prototype.setHeight = function(height){
this.height = height;
}
/**
* Get the value for the total area of this Rectangle.
* @return total area of this Rectangle
* @type int
*/
geometry.Rectangle.prototype.getArea = function(){
return width * height;
}
/**
* Create a new Square instance.
* @class A Square is a subclass of {@link geometry.Rectangle}
* @param {int} width The optional width for this Rectangle
* @param {int} height The optional height for this Rectangle
* @extends geometry.Rectangle
*/
geometry.Square = function(width, height){
if (width){
this.width = width;
if (height){
this.height = height;
}
}
}
/* Square is a subclass of Rectangle */
geometry.Square.prototype = new geometry.Rectangle();
/**
* Set the width value for this Shape.
* @param {int} width The width value to be set
* @see #getWidth
*/
geometry.Square.prototype.setWidth = function(width){
this.width = this.height = width;
}
/**
* Set the height value for this Shape.
* Sets the {@link geometry.Rectangle#height} attribute in the Rectangle.
* @param {int} height The height value to be set
*/
geometry.Square.prototype.setHeight = function(height){
this.height = this.width = height;
}
/**
* Create a new Circle instance based on a radius.
* @class Circle class is another subclass of Shape
* @extends geometry.Shape
* @param {int} radius The optional radius of this {@link geometry.Circle }
*/
geometry.Circle = function(radius){
if (radius) {
/** The radius of the this Circle. */
this.radius = radius;
}
/**
* @property
*/
this.area = getArea.call(this);
}
/* Circle inherits from {@link geometry.Shape} */
geometry.Circle.prototype = new geometry.Shape();
/**
* The radius value for this Circle.
* @private
* @type int
*/
geometry.Circle.prototype.radius = 0;
/**
* A field that is also a constant.
* @const
* @type float
*/
geometry.Circle.PI = 3.14;
/**
* Get the radius value for this Circle.
* @type int
* @see #setRadius
*/
geometry.Circle.prototype.getRadius = function(){
return this.radius;
}
/**
* Set the radius value for this Circle.
* @param {int} radius The {@link geometry.Circle#radius} value to set
* @see #getRadius
*/
geometry.Circle.prototype.setRadius = function(radius){
this.radius = radius;
}
/**
* @method geometry.Circle#setDiameter
*/
geometry.Circle.prototype.setDiameter = geometry.Square.prototype.setWidth;
/**
* An example of a class (static) method that acts as a factory for Circle objects.
* Given a radius value, this method creates a new Circle.
* @param {int} radius The radius value to use for the new Circle.
* @type geometry.Circle
*/
geometry.Circle.createCircle = function(radius){
return new geometry.Circle(radius);
}
/**
* Create a new Coordinate instance based on x and y grid data.
* @class Coordinate is a class that can encapsulate location information.
* @param {int} [x=0] The optional x portion of the Coordinate
* @param {int} [y=0] The optinal y portion of the Coordinate
*/
geometry.Coordinate = function(x, y){
if (x){
this.x = x;
if (y){
this.y = y;
}
}
}
/**
* The x portion of the Coordinate.
* @type {int}
* @see #getX
* @see #setX
*/
geometry.Coordinate.prototype.x = 0;
/**
* The y portion of the Coordinate.
* @type int
* @see #getY
* @see #setY
*/
geometry.Coordinate.prototype.y = 0;
/**
* Gets the x portion of the Coordinate.
* @type int
* @see #setX
*/
geometry.Coordinate.prototype.getX = function(){
return this.x;
}
/**
* Get the y portion of the Coordinate.
* @type int
* @see #setY
*/
geometry.Coordinate.prototype.getY = function(){
return this.y;
}
/**
* Sets the x portion of the Coordinate.
* @param {int} x The x value to set
* @see #getX
*/
geometry.Coordinate.prototype.setX = function(x){
this.x = x;
}
/**
* Sets the y portion of the Coordinate.
* @param {int} y The y value to set
* @see #getY
*/
geometry.Coordinate.prototype.setY = function(y){
this.y = y;
}
/**
* An example of a singleton class.
* @param ... Arguments represent {@link coordinate}s in the shape.
* @constructor
*/
MySingletonShapeFactory = function(){
/**
* Get the next {@link geometry.Shape}.
* @type geometry.Shape
* @return A new {@link geometry.Shape}
*/
this.getShape = function(){
return null;
}
}
/**
* Create a new Foo instance.
* @class This is the Foo class. It exists to demonstrate 'nested' classes.
* @constructor
* @see Foo.Bar
*/
function Foo(){}
/**
* Nested class.
* @constructor
*/
Foo.Bar = function(){
/** The x. */ this.x = 2;
}
Foo.Bar.prototype = new Bar();
/** The y. */
Foo.Bar.prototype.y = '3';
// private method, as in the module pattern
/**
* @private
* @this {geometry.Circle}
*/
function _getArea() {
}
// see http://www.integralist.co.uk/javascript/implementing-interfaces-in-javascript/
/**
Adds functionality related to three-dimensional calculations.
@protected
@mixin
*/
var threeD = new Interface('threeD');
/**
Getter and setter for the z axis.
@method
@param {number} v
*/
threeD.axisZ = Interface.method('number:v');
/** @class
@implements {threeD}
*/
geometry.Cube = function(opts) {
Interface.ensureImplements(opts.methods, threeD);
}

0
test/samples/src/dir1/three.js
View File

0
test/samples/src/ignored.txt
View File

0
test/samples/src/one.js
View File

0
test/samples/src/two.js
View File

6
test/samples/tag_class.js
View File

@ -1,6 +0,0 @@
/**
@name Foo
@class This is the foo class.
@constructor
*/

10
test/samples/tag_const.js
View File

@ -1,10 +0,0 @@
/** @const {string} */ var MY_BEER = 'stout';
/**
* My namespace's favorite kind of beer.
* @const
* @type {string}
*/
mynamespace.MY_BEER = 'stout';
/** @const */ MyClass.MY_BEER = 'stout';

23
test/samples/tag_constructor.js
View File

@ -1,23 +0,0 @@
/**
@name Foo
@constructor
*/
/**
@constructor Bar
*/
/** @constructor */
function Pez() {
}
/** @constructor */
Qux = function() {
}
var somevar,
/** @constructor */
Blap = function(a, b) {
};

12
test/samples/tag_exception.js
View File

@ -1,12 +0,0 @@
/**
* @function divide
* @throws {divideByZeroError} Denominator param cannot be zero.
*/
function divide(a, b) {}
/**
* @function read
* @throws {fileNotFoundError}
* @throws {fileTooLargeError}
*/
function read(filepath) {}

21
test/samples/tag_file_1.js
View File

@ -1,21 +0,0 @@
/**
* @fileoverview This file is to be used for testing the JSDoc parser
* It is not intended to be an example of good JavaScript OO-programming,
* nor is it intended to fulfill any specific purpose apart from
* demonstrating the functionality of the
* {@link http://sourceforge.net/projects/jsdoc JSDoc} parser
*
* @author Michael Mathews <micmath@gmail.com>
* @version 0.1
*/
function Shape(){
this.getClassName = function(){
return "Shape";
}
function addReference(){
// Do nothing...
}
}

12
test/samples/tag_fires.js
View File

@ -1,12 +0,0 @@
/**
* @constructor Widget
* @fires event:disable
*/
function Widget() {}
/**
* @constructor Overlay
* @fires event:show
* @fires event:hide
*/
function Overlay() {}

11
test/samples/tag_ignore.js
View File

@ -1,11 +0,0 @@
/**
@ignore
@name Foo
@constructor
*/
/**
@name Bar
@constructor
*/

49
test/samples/tag_member.js
View File

@ -1,49 +0,0 @@
/** @namespace foo */
/** @constructor bar */
/**
@method fah
@memberof foo.prototype
*/
/**
@property bah
@member bar
*/
/**
@inner
@property bish
@member bar
*/
/**
@scope instance
@property bosh
@member bar
*/
/** An unnamed aliased static var
@static
@property
@memberof foo
*/
var bar = 1;
var foo = function() {}; foo.bar = bar;
/** An unnamed, aliased inner var
@inner
@property
@memberof foz
*/
var baz = 1;
(function(v) {
foz = function() {var baz = v; };
})(baz);
/**
@memberof foo~
*/
function innie() {}

7
test/samples/tag_module.js
View File

@ -1,7 +0,0 @@
/**
* @module ./webui/utils.strings
*/
/** @method */
exports.twiddle = function() {
}

19
test/samples/tag_name.js
View File

@ -1,19 +0,0 @@
/**
@name Tipsy
@kind property
*/
/**
@name Tubbie.LaLa
@kind property
*/
/**
@name Tubbie."and.don't.forget#Po!"
@kind property
*/
/**
@name Custards.0
@kind property
*/

31
test/samples/tag_param.js
View File

@ -1,31 +0,0 @@
/**
* @method sendTo
* @param address
* @param message
*/
/**
* @method str_concat
* @param {string}
* @param {string}
*/
/**
* @method str_reverse
* @param {string} str
*/
/**
* @method str_rot13
* @param {string}
message
the message to encrypt.
*/
/**
* @method update
* @param {Panel} p - The panel to update.
* @param - The new content.
* @param {boolean} - Don't replace existing content.
*/

8
test/samples/tag_preserve.js
View File

@ -1,8 +0,0 @@
var foo = 1;
/**
* @preserve Copyright 2009 SomeThirdParty.
* Here is the full license text and copyright
* notice for this file. Note that the notice can span several
* lines and is only terminated by the closing star and slash:
*/
function Bar() {}

22
test/samples/tag_scope.js
View File

@ -1,22 +0,0 @@
/** A global function
@function
*/
function outie() {
/** An inner function */
function innie(){}
}
/** A static function
@function
*/
outie.stat = function() {
}
/** A global var function
@function
*/
var varoutie = function() {
/** An inner var function */
var varinnie = function() {
}
}

15
test/samples/tag_tag.js
View File

@ -1,15 +0,0 @@
/** @namespace foo
@tag hilited
*/
/** @namespace baz
@tag experimental
@tag lots of words
*/
/** @namespace bar
@tag
*/
/** @namespace zub
*/

24
test/samples/tag_type.js
View File

@ -1,24 +0,0 @@
/** @namespace foo */
/** @constructor bar */
/**
@property foo#fah
@type number
*/
/**
@property foo#fahfah
@type number | Array.<number>
*/
/**
@property bar.bah
@type {{myNum: number, myObject}|function(string:a, string:b){}:number}
*/
/**
* The message hex ID.
* @property hexId
* @type {(string|number)}
*/