/branches/version1.x/examples/data/overview.js

http://jsdoc-toolkit.googlecode.com/ · JavaScript · 45 lines · 2 code · 2 blank · 41 comment · 0 complexity · c974b00f504f54dfa33bd1e54b204291 MD5 · raw file 

    

  1. /**
    2. 

  2.  * @fileOverview A collection of functions for records.
    3. 

  3.  * @name Record Keeper
    4. 

  4.  */
    5. 

  5.  
    6. 

  6. /** 
    7. 

  7.  * Gets the current record. 
    8. 

  8.  */
    9. 

  9. function getRecord(){
    10. 

  10. }
    11. 

  11. 

  12. /*
    13. 

  13. [
    14. 

  14.     {
    15. 

  15.         symbols: [
    16. 

  16.             {
    17. 

  17.                 doc: { tags: [] },
    18. 

  18.                 returns: [],
    19. 

  19.                 type: "",
    20. 

  20.                 properties: [],
    21. 

  21.                 isa: "FUNCTION",
    22. 

  22.                 desc: "Gets the current record.",
    23. 

  23.                 alias: "getRecord",
    24. 

  24.                 memberof: "",
    25. 

  25.                 params: [],
    26. 

  26.                 methods: [],
    27. 

  27.                 name: "getRecord"
    28. 

  28.             }
    29. 

  29.         ],
    30. 

  30.         overview: {
    31. 

  31.             doc: { tags: [] },
    32. 

  32.             returns: [],
    33. 

  33.             type: "",
    34. 

  34.             properties: [],
    35. 

  35.             isa: "FILE",
    36. 

  36.             desc: "A collection of functions for records.",
    37. 

  37.             alias: "examples/data/overview.js",
    38. 

  38.             memberof: "",
    39. 

  39.             params: [],
    40. 

  40.             methods: [],
    41. 

  41.             name: "Record Keeper"
    42. 

  42.         }
    43. 

  43.     }
    44. 

  44. ]
    45. 

  45. */
    46.