File: overview.js

package info (click to toggle)
node-jsdoc2 2.4.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 708 kB
  • sloc: javascript: 4,319; xml: 279; makefile: 19; sh: 4
file content (20 lines) | stat: -rw-r--r-- 437 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
/**
 * @overview This "library" contains a 
 *               lot of classes and functions.
 * @example
 <pre>
	var x (x < 1);
	alert("This 'is' \"code\"");
 </pre>
 * @name My Cool Library
 * @author 	Joe Smith jsmith@company.com
 * @version 	0.1 
 */
 
/** 
 * Gets the current foo 
 * @param {String} fooId	The unique identifier for the foo.
 * @return {Object}	Returns the current foo.
 */
function getFoo(fooID){
}