Mercurial Mercurial > metadataplayer / annotate
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
sbin/res/jsdoc/app/test/overview.js
author hamidouk
Fri, 23 Dec 2011 11:38:47 +0100
branchjsdoc
changeset 520 fe008e95a716
permissions -rw-r--r--
added jsdoc support, and a script to generate the docs. Also added sample documentation for the IriSP.widget base class.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
520
fe008e95a716 added jsdoc support, and a script to generate the docs.
hamidouk
parents:
diff changeset 
     1
 
/**
fe008e95a716 added jsdoc support, and a script to generate the docs.
hamidouk
parents:
diff changeset 
     2
 
 * @overview This "library" contains a
fe008e95a716 added jsdoc support, and a script to generate the docs.
hamidouk
parents:
diff changeset 
     3
 
 *               lot of classes and functions.
fe008e95a716 added jsdoc support, and a script to generate the docs.
hamidouk
parents:
diff changeset 
     4
 
 * @example
fe008e95a716 added jsdoc support, and a script to generate the docs.
hamidouk
parents:
diff changeset 
     5
 
 <pre>
fe008e95a716 added jsdoc support, and a script to generate the docs.
hamidouk
parents:
diff changeset 
     6
 
	var x (x < 1);
fe008e95a716 added jsdoc support, and a script to generate the docs.
hamidouk
parents:
diff changeset 
     7
 
	alert("This 'is' \"code\"");
fe008e95a716 added jsdoc support, and a script to generate the docs.
hamidouk
parents:
diff changeset 
     8
 
 </pre>
fe008e95a716 added jsdoc support, and a script to generate the docs.
hamidouk
parents:
diff changeset 
     9
 
 * @name My Cool Library
fe008e95a716 added jsdoc support, and a script to generate the docs.
hamidouk
parents:
diff changeset 
    10
 
 * @author 	Joe Smith jsmith@company.com
fe008e95a716 added jsdoc support, and a script to generate the docs.
hamidouk
parents:
diff changeset 
    11
 
 * @version 	0.1
fe008e95a716 added jsdoc support, and a script to generate the docs.
hamidouk
parents:
diff changeset 
    12
 
 */
fe008e95a716 added jsdoc support, and a script to generate the docs.
hamidouk
parents:
diff changeset 
    13
fe008e95a716 added jsdoc support, and a script to generate the docs.
hamidouk
parents:
diff changeset 
    14
 
/**
fe008e95a716 added jsdoc support, and a script to generate the docs.
hamidouk
parents:
diff changeset 
    15
 
 * Gets the current foo
fe008e95a716 added jsdoc support, and a script to generate the docs.
hamidouk
parents:
diff changeset 
    16
 
 * @param {String} fooId	The unique identifier for the foo.
fe008e95a716 added jsdoc support, and a script to generate the docs.
hamidouk
parents:
diff changeset 
    17
 
 * @return {Object}	Returns the current foo.
fe008e95a716 added jsdoc support, and a script to generate the docs.
hamidouk
parents:
diff changeset 
    18
 
 */
fe008e95a716 added jsdoc support, and a script to generate the docs.
hamidouk
parents:
diff changeset 
    19
 
function getFoo(fooID){
fe008e95a716 added jsdoc support, and a script to generate the docs.
hamidouk
parents:
diff changeset 
    20
 
}
metadataplayer