Add ruby generation as example (#24)

Co-authored-by: Stanislav (Stas) Katkov <github@skatkov.com>

.gitignore

@@ -8,3 +8,5 @@
 /tmp/
 .vscode/
 .DS_Store
+// file is just to big.
+example/ruby/index.csv

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "source_ruby"]
+	path = source_ruby
+	url = https://github.com/ruby/ruby

.yardopts

@@ -1,4 +1,2 @@
 --load ./lib/yard-markdown.rb
 --format markdown
---private
---protected

Rakefile

@@ -12,8 +12,24 @@ end
 task default: %i[test stree:write]
 
 
-desc "Generate example/rdoc/ documentation using yard-markdown plugin"
-task :generate_example do
-  sh "yardoc --output-dir example/rdoc example_rdoc.rb"
-  sh "yardoc --output-dir example/yard example_yard.rb"
+namespace :examples do
+  desc "Generate example/rdoc/ documentation using yard-markdown plugin"
+  task :generate do
+    Rake::Task["examples:yard"].invoke
+    Rake::Task["examples:rdoc"].invoke
+    Rake::Task["examples:ruby"].invoke
+  end
+
+
+  task :yard do
+    sh "yardoc --output-dir example/yard example_yard.rb"
+  end
+
+  task :rdoc do
+    sh "yardoc --output-dir example/rdoc example_rdoc.rb"
+  end
+
+  task :ruby do
+    sh "yardoc source_ruby --output-dir example/ruby"
+  end
 end

example/ruby/A.md

@@ -0,0 +1,7 @@
+# Class: A
+**Inherits:** Object
+
+
+
+
+

example/ruby/ACRONYM.md

@@ -0,0 +1,6 @@
+# Module: ACRONYM
+
+
+
+
+

example/ruby/Action.md

@@ -0,0 +1,22 @@
+# Class: Action
+**Inherits:** Object
+
+
+
+
+# Attributes
+## value[RW] [](#attribute-i-value)
+Returns the value of attribute value.
+
+
+#Instance Methods
+## eql?(other) [](#method-i-eql?)
+
+**@return** [Boolean] 
+
+## hash() [](#method-i-hash)
+
+## initialize(value) [](#method-i-initialize)
+
+**@return** [Action] a new instance of Action
+

example/ruby/ActionFilter.md

@@ -0,0 +1,26 @@
+# Class: ActionFilter
+**Inherits:** Object
+
+
+ActionFilter is a base class for actions that are triggered by specs that
+match the filter. The filter may be specified by strings that match spec
+descriptions or by tags for strings that match spec descriptions.
+
+Unlike TagFilter and RegexpFilter, ActionFilter instances do not affect the
+specs that are run. The filter is only used to trigger the action.
+
+
+
+#Instance Methods
+## ===(string) [](#method-i-===)
+
+## initialize(tagsnil, descsnil) [](#method-i-initialize)
+
+**@return** [ActionFilter] a new instance of ActionFilter
+
+## load() [](#method-i-load)
+
+## register() [](#method-i-register)
+
+## unregister() [](#method-i-unregister)
+

example/ruby/ActionMap.md

@@ -0,0 +1,47 @@
+# Class: ActionMap
+**Inherits:** Object
+
+
+
+
+# Class Methods
+## build_tree(rects ) [](#method-c-build_tree)
+## each_firstbyte_range(prefix , region_rects ) [](#method-c-each_firstbyte_range)
+## expand(rects , &block ) [](#method-c-expand)
+## expand_rec(prefix , region_rects , &block ) [](#method-c-expand_rec)
+## merge(*mappings , &block ) [](#method-c-merge)
+## merge2(map1 , map2 , &block ) [](#method-c-merge2)
+## merge_rects(*rects_list ) [](#method-c-merge_rects)
+## parse(mapping ) [](#method-c-parse)
+## parse_to_rects(mapping ) [](#method-c-parse_to_rects)
+## unambiguous_action(actions0 ) [](#method-c-unambiguous_action)
+
+#Instance Methods
+## empty_action() [](#method-i-empty_action)
+
+## format_infos(infos) [](#method-i-format_infos)
+
+## format_offsets(min, max, offsets) [](#method-i-format_offsets)
+
+## gen_str(bytes) [](#method-i-gen_str)
+
+## generate_info(info) [](#method-i-generate_info)
+
+## generate_lookup_node(name, table) [](#method-i-generate_lookup_node)
+
+## generate_node(name_hintnil) [](#method-i-generate_node)
+
+## gennode(bytes_code, words_code, name_hintnil) [](#method-i-gennode)
+
+## initialize(tree) [](#method-i-initialize)
+
+**@return** [ActionMap] a new instance of ActionMap
+
+## inspect() [](#method-i-inspect)
+
+## max_input_length() [](#method-i-max_input_length)
+
+## max_input_length_rec(tree) [](#method-i-max_input_length_rec)
+
+## str_name(bytes) [](#method-i-str_name)
+