{
    "content": [
        {
            "type": "text",
            "text": "# RDoc::Generator::JsonIndex (ri)\n\n## Section Outline\n\n- **RDoc::Generator::JsonIndex < Object** (1 lines)\n- **Includes:** (24 lines) — 2 subsections\n  - Index Format (23 lines)\n  - LICENSE (21 lines)\n- **Constants:** (4 lines)\n- **Class methods:** (2 lines)\n- **Instance methods:** (9 lines)\n\n## Full Content\n\n### RDoc::Generator::JsonIndex < Object\n\n------------------------------------------------------------------------\n\n### Includes:\n\nRDoc::Text (from gem rdoc-7.2.0)\n\n(from gem rdoc-7.2.0)\n------------------------------------------------------------------------\nThe JsonIndex generator is designed to complement an HTML generator and\nproduces a JSON search index.  This generator is derived from sdoc by\nVladimir Kolesnikov and contains verbatim code written by him.\n\nThis generator is designed to be used with a regular HTML generator:\n\nclass RDoc::Generator::Darkfish\ndef initialize options\n# ...\n@basedir = Pathname.pwd.expandpath\n\n@jsonindex = RDoc::Generator::JsonIndex.new self, options\nend\n\ndef generate\n# ...\n@jsonindex.generate\nend\nend\n\n#### Index Format\n\nThe index is output as a JSON file assigned to the global variable\nsearchdata.  The structure is:\n\nvar searchdata = {\n\"index\": {\n\"searchIndex\":\n[\"a\", \"b\", ...],\n\"longSearchIndex\":\n[\"a\", \"a::b\", ...],\n\"info\": [\n[\"A\", \"A\", \"A.html\", \"\", \"\"],\n[\"B\", \"A::B\", \"A::B.html\", \"\", \"\"],\n...\n]\n}\n}\n\nThe same item is described across the searchIndex, longSearchIndex and\ninfo fields.  The searchIndex field contains the item's short name, the\nlongSearchIndex field contains the fullname (when appropriate) and the\ninfo field contains the item's name, fullname, path, parameters and a\nsnippet of the item's comment.\n\n#### LICENSE\n\nCopyright (c) 2009 Vladimir Kolesnikov\n\nPermission is hereby granted, free of charge, to any person obtaining a\ncopy of this software and associated documentation files (the\n\"Software\"), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be included\nin all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS\nOR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\nIN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\nCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\nTORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\nSOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n------------------------------------------------------------------------\n\n### Constants:\n\nSEARCHINDEXFILE:\nWhere the search index lives in the generated output\n\n### Class methods:\n\nnew\n\n### Instance methods:\n\nbuildindex\ndebugmsg\ngenerate\ngenerategzipped\nindexclasses\nindexmethods\nindexpages\nsearchstring\n\n"
        }
    ],
    "structuredContent": {
        "command": "RDoc::Generator::JsonIndex",
        "section": "",
        "mode": "ri",
        "summary": null,
        "synopsis": null,
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "RDoc::Generator::JsonIndex < Object",
                "lines": 1,
                "subsections": []
            },
            {
                "name": "Includes:",
                "lines": 24,
                "subsections": [
                    {
                        "name": "Index Format",
                        "lines": 23
                    },
                    {
                        "name": "LICENSE",
                        "lines": 21
                    }
                ]
            },
            {
                "name": "Constants:",
                "lines": 4,
                "subsections": []
            },
            {
                "name": "Class methods:",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "Instance methods:",
                "lines": 9,
                "subsections": []
            }
        ]
    }
}