/tags/jsdoc_toolkit-2.2.1/jsdoc-toolkit/app/test/overview.js

http://jsdoc-toolkit.googlecode.com/ · JavaScript · 20 lines · 2 code · 1 blank · 17 comment · 0 complexity · c83765969af33dbb48a81362f2ef735e MD5 · raw file 

    

  1. /**
    2. 

  2.  * @overview This "library" contains a 
    3. 

  3.  *               lot of classes and functions.
    4. 

  4.  * @example
    5. 

  5.  <pre>
    6. 

  6. 	var x (x < 1);
    7. 

  7. 	alert("This 'is' \"code\"");
    8. 

  8.  </pre>
    9. 

  9.  * @name My Cool Library
    10. 

  10.  * @author 	Joe Smith jsmith@company.com
    11. 

  11.  * @version 	0.1 
    12. 

  12.  */
    13. 

  13.  
    14. 

  14. /** 
    15. 

  15.  * Gets the current foo 
    16. 

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

  17.  * @return {Object}	Returns the current foo.
    18. 

  18.  */
    19. 

  19. function getFoo(fooID){
    20. 

  20. }
    21.