RDoc::Generator::JsonIndex - ri - phpman

= RDoc::Generator::JsonIndex < Object

------------------------------------------------------------------------
= Includes:
RDoc::Text (from gem rdoc-7.2.0)

(from gem rdoc-7.2.0)
------------------------------------------------------------------------
The JsonIndex generator is designed to complement an HTML generator and
produces a JSON search index.  This generator is derived from sdoc by
Vladimir Kolesnikov and contains verbatim code written by him.

This generator is designed to be used with a regular HTML generator:

  class RDoc::Generator::Darkfish
    def initialize options
      # ...
      @base_dir = Pathname.pwd.expand_path

      @json_index = RDoc::Generator::JsonIndex.new self, options
    end

    def generate
      # ...
      @json_index.generate
    end
  end

== Index Format

The index is output as a JSON file assigned to the global variable
search_data.  The structure is:

  var search_data = {
    "index": {
      "searchIndex":
        ["a", "b", ...],
      "longSearchIndex":
        ["a", "a::b", ...],
      "info": [
        ["A", "A", "A.html", "", ""],
        ["B", "A::B", "A::B.html", "", ""],
        ...
      ]
    }
  }

The same item is described across the searchIndex, longSearchIndex and
info fields.  The searchIndex field contains the item's short name, the
longSearchIndex field contains the full_name (when appropriate) and the
info field contains the item's name, full_name, path, parameters and a
snippet of the item's comment.

== LICENSE

Copyright (c) 2009 Vladimir Kolesnikov

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
------------------------------------------------------------------------
= Constants:

SEARCH_INDEX_FILE:
  Where the search index lives in the generated output


= Class methods:

  new

= Instance methods:

  build_index
  debug_msg
  generate
  generate_gzipped
  index_classes
  index_methods
  index_pages
  search_string