/tags/jsdoc_toolkit-1.4.0/examples/data/virtual.js

http://jsdoc-toolkit.googlecode.com/ · JavaScript · 76 lines · 0 code · 1 blank · 75 comment · 0 complexity · 2bb8ad624877144811b5002369ae68c1 MD5 · raw file

  1. /**
  2. * The file index.
  3. * @name fileIndex
  4. */
  5. /**
  6. * A file indexer.
  7. * @name Indexer
  8. * @constructor
  9. */
  10. /**
  11. * Get the file's index.
  12. * @name getIndex
  13. * @function
  14. * @memberOf Indexer
  15. */
  16. /*
  17. [
  18. {
  19. symbols: [
  20. {
  21. doc: { tags: [] },
  22. returns: [],
  23. type: "",
  24. properties: [],
  25. isa: "OBJECT",
  26. desc: "The file index.",
  27. alias: "fileIndex",
  28. memberof: "",
  29. params: [],
  30. methods: [],
  31. name: "fileIndex"
  32. },
  33. {
  34. doc: { tags: [] },
  35. returns: [],
  36. type: "",
  37. properties: [],
  38. isa: "CONSTRUCTOR",
  39. desc: "A file indexer.",
  40. alias: "Indexer",
  41. memberof: "",
  42. params: [],
  43. methods: [ { name: "getIndex", alias: "Indexer.getIndex" } ],
  44. name: "Indexer"
  45. },
  46. {
  47. doc: { tags: [] },
  48. returns: [],
  49. type: "",
  50. properties: [],
  51. isa: "FUNCTION",
  52. desc: "Get the file's index.",
  53. alias: "Indexer.getIndex",
  54. memberof: "Indexer",
  55. params: [],
  56. methods: [],
  57. name: "getIndex"
  58. }
  59. ],
  60. overview: {
  61. doc: { tags: [] },
  62. returns: [],
  63. type: "",
  64. properties: [],
  65. isa: "FILE",
  66. desc: "No overview provided.",
  67. alias: "examples/data/virtual.js",
  68. memberof: "",
  69. params: [],
  70. methods: [],
  71. name: "examples/data/virtual.js"
  72. }
  73. }
  74. ]
  75. */