Linux heracles.o2switch.net 4.18.0-553.62.1.lve.el8.x86_64 #1 SMP Mon Jul 21 17:50:35 UTC 2025 x86_64
/
opt
/
alt
/
ruby21
/
share
/
ri
/
2.1.0
/
system
/
RDoc
/
Generator
/
JsonIndex
/
//opt/alt/ruby21/share/ri/2.1.0/system/RDoc/Generator/JsonIndex/cdesc-JsonIndex.ri
U:RDoc::NormalClass[iI"JsonIndex:ETI"RDoc::Generator::JsonIndex;TI"Object;To:RDoc::Markup::Document:@parts[o;;[o:RDoc::Markup::Paragraph;[I"MThe JsonIndex generator is designed to complement an HTML generator and ;TI"Kproduces a JSON search index. This generator is derived from sdoc by ;TI"CVladimir Kolesnikov and contains verbatim code written by him.;To:RDoc::Markup::BlankLine o; ;[I"IThis generator is designed to be used with a regular HTML generator:;T@o:RDoc::Markup::Verbatim;[I"%class RDoc::Generator::Darkfish ;TI" def initialize options ;TI" # ... ;TI". @base_dir = Pathname.pwd.expand_path ;TI" ;TI"D @json_index = RDoc::Generator::JsonIndex.new self, options ;TI" end ;TI" ;TI" def generate ;TI" # ... ;TI" @json_index.generate ;TI" end ;TI" end ;T:@format0S:RDoc::Markup::Heading: leveli: textI"Index Format;T@o; ;[I"HThe index is output as a JSON file assigned to the global variable ;TI"&+search_data+. The structure is:;T@o;;[I"var search_data = { ;TI" "index": { ;TI" "searchIndex": ;TI" ["a", "b", ...], ;TI" "longSearchIndex": ;TI" ["a", "a::b", ...], ;TI" "info": [ ;TI") ["A", "A", "A.html", "", ""], ;TI"/ ["B", "A::B", "A::B.html", "", ""], ;TI" ... ;TI" ] ;TI" } ;TI"} ;T;0o; ;[ I"PThe same item is described across the +searchIndex+, +longSearchIndex+ and ;TI"Q+info+ fields. The +searchIndex+ field contains the item's short name, the ;TI"O+longSearchIndex+ field contains the full_name (when appropriate) and the ;TI"N+info+ field contains the item's name, full_name, path, parameters and a ;TI"#snippet of the item's comment.;T@S; ;i;I"LICENSE;T@o; ;[I"+Copyright (c) 2009 Vladimir Kolesnikov;T@o; ;[I"KPermission is hereby granted, free of charge, to any person obtaining ;TI"Ea copy of this software and associated documentation files (the ;TI"I"Software"), to deal in the Software without restriction, including ;TI"Iwithout limitation the rights to use, copy, modify, merge, publish, ;TI"Hdistribute, sublicense, and/or sell copies of the Software, and to ;TI"Kpermit persons to whom the Software is furnished to do so, subject to ;TI"the following conditions:;T@o; ;[I"DThe above copyright notice and this permission notice shall be ;TI"Dincluded in all copies or substantial portions of the Software.;T@o; ;[I"ETHE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, ;TI"HEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF ;TI";MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND ;TI"LNONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE ;TI"LLIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION ;TI"KOF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION ;TI"DWITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.;T: @fileI"%lib/rdoc/generator/json_index.rb;T:0@omit_headings_from_table_of_contents_below0;0;0[ [U:RDoc::Constant[i I"SEARCH_INDEX_FILE;FI"2RDoc::Generator::JsonIndex::SEARCH_INDEX_FILE;T00o;;[o; ;[I"9Where the search index lives in the generated output;T;@];0@]@cRDoc::NormalClass0[[I"RDoc::Text;To;;[ ;@];0I"%lib/rdoc/generator/json_index.rb;T[[I" class;T[[:public[[I"new;T@o[:protected[ [:private[ [I" instance;T[[;[[I"build_index;F@o[I"class_dir;F@o[I"debug_msg;F@o[I" file_dir;F@o[I" generate;F@o[I"index_classes;F@o[I"index_methods;F@o[I"index_pages;F@o[I"search_string;F@o[;[ [;[ [ [U:RDoc::Context::Section[i 0o;;[ ;0;0[@]@]cRDoc::TopLevel