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

 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    {
20        symbols: [
21            {
22                doc: { tags: [] },
23                returns: [],
24                type: "",
25                properties: [],
26                isa: "OBJECT",
27                desc: "The file index.",
28                alias: "fileIndex",
29                memberof: "",
30                params: [],
31                methods: [],
32                name: "fileIndex"
33            },
34            {
35                doc: { tags: [] },
36                returns: [],
37                type: "",
38                properties: [],
39                isa: "CONSTRUCTOR",
40                desc: "A file indexer.",
41                alias: "Indexer",
42                memberof: "",
43                params: [],
44                methods: [ { name: "getIndex", alias: "Indexer.getIndex" } ],
45                name: "Indexer"
46            },
47            {
48                doc: { tags: [] },
49                returns: [],
50                type: "",
51                properties: [],
52                isa: "FUNCTION",
53                desc: "Get the file's index.",
54                alias: "Indexer.getIndex",
55                memberof: "Indexer",
56                params: [],
57                methods: [],
58                name: "getIndex"
59            }
60        ],
61        overview: {
62            doc: { tags: [] },
63            returns: [],
64            type: "",
65            properties: [],
66            isa: "FILE",
67            desc: "No overview provided.",
68            alias: "examples/data/virtual.js",
69            memberof: "",
70            params: [],
71            methods: [],
72            name: "examples/data/virtual.js"
73        }
74    }
75]
76*/