rdoc 5.1.0 → 6.3.1
Sign up to get free protection for your applications and to get access to all the features.
Potentially problematic release.
This version of rdoc might be problematic. Click here for more details.
- checksums.yaml +5 -5
- data/CONTRIBUTING.rdoc +4 -4
- data/Gemfile +9 -0
- data/History.rdoc +4 -4
- data/README.rdoc +5 -6
- data/Rakefile +35 -67
- data/lib/rdoc/alias.rb +1 -1
- data/lib/rdoc/anon_class.rb +1 -1
- data/lib/rdoc/any_method.rb +59 -15
- data/lib/rdoc/attr.rb +1 -1
- data/lib/rdoc/class_module.rb +5 -3
- data/lib/rdoc/code_object.rb +2 -9
- data/lib/rdoc/code_objects.rb +1 -1
- data/lib/rdoc/comment.rb +32 -11
- data/lib/rdoc/constant.rb +3 -3
- data/lib/rdoc/context/section.rb +1 -14
- data/lib/rdoc/context.rb +63 -20
- data/lib/rdoc/cross_reference.rb +33 -15
- data/lib/rdoc/encoding.rb +58 -30
- data/lib/rdoc/erb_partial.rb +2 -2
- data/lib/rdoc/erbio.rb +8 -4
- data/lib/rdoc/extend.rb +1 -1
- data/lib/rdoc/generator/darkfish.rb +60 -29
- data/lib/rdoc/generator/json_index.rb +6 -3
- data/lib/rdoc/generator/markup.rb +3 -13
- data/lib/rdoc/generator/pot/message_extractor.rb +1 -1
- data/lib/rdoc/generator/pot/po.rb +3 -3
- data/lib/rdoc/generator/pot/po_entry.rb +11 -11
- data/lib/rdoc/generator/pot.rb +4 -4
- data/lib/rdoc/generator/ri.rb +1 -1
- data/lib/rdoc/generator/template/darkfish/_footer.rhtml +2 -2
- data/lib/rdoc/generator/template/darkfish/_head.rhtml +9 -7
- data/lib/rdoc/generator/template/darkfish/_sidebar_VCS_info.rhtml +2 -2
- data/lib/rdoc/generator/template/darkfish/_sidebar_classes.rhtml +2 -2
- data/lib/rdoc/generator/template/darkfish/_sidebar_extends.rhtml +7 -7
- data/lib/rdoc/generator/template/darkfish/_sidebar_in_files.rhtml +2 -2
- data/lib/rdoc/generator/template/darkfish/_sidebar_includes.rhtml +7 -7
- data/lib/rdoc/generator/template/darkfish/_sidebar_installed.rhtml +6 -6
- data/lib/rdoc/generator/template/darkfish/_sidebar_methods.rhtml +5 -5
- data/lib/rdoc/generator/template/darkfish/_sidebar_pages.rhtml +5 -5
- data/lib/rdoc/generator/template/darkfish/_sidebar_parent.rhtml +5 -5
- data/lib/rdoc/generator/template/darkfish/_sidebar_sections.rhtml +4 -4
- data/lib/rdoc/generator/template/darkfish/_sidebar_table_of_contents.rhtml +4 -4
- data/lib/rdoc/generator/template/darkfish/class.rhtml +45 -47
- data/lib/rdoc/generator/template/darkfish/css/rdoc.css +55 -6
- data/lib/rdoc/generator/template/darkfish/index.rhtml +3 -4
- data/lib/rdoc/generator/template/darkfish/js/darkfish.js +22 -99
- data/lib/rdoc/generator/template/darkfish/js/search.js +32 -31
- data/lib/rdoc/generator/template/darkfish/servlet_root.rhtml +15 -16
- data/lib/rdoc/generator/template/darkfish/table_of_contents.rhtml +16 -16
- data/lib/rdoc/generator/template/json_index/js/navigation.js +4 -41
- data/lib/rdoc/generator/template/json_index/js/searcher.js +6 -6
- data/lib/rdoc/generator.rb +1 -1
- data/lib/rdoc/ghost_method.rb +1 -1
- data/lib/rdoc/i18n/locale.rb +1 -1
- data/lib/rdoc/i18n/text.rb +5 -5
- data/lib/rdoc/i18n.rb +3 -3
- data/lib/rdoc/include.rb +1 -1
- data/lib/rdoc/known_classes.rb +1 -1
- data/lib/rdoc/markdown/entities.rb +1 -1
- data/lib/rdoc/markdown/literals.kpeg +1 -0
- data/lib/rdoc/markdown/literals.rb +19 -7
- data/lib/rdoc/markdown.kpeg +92 -44
- data/lib/rdoc/markdown.rb +1171 -610
- data/lib/rdoc/markup/attr_changer.rb +1 -1
- data/lib/rdoc/markup/attr_span.rb +9 -3
- data/lib/rdoc/markup/attribute_manager.rb +115 -50
- data/lib/rdoc/markup/attributes.rb +7 -7
- data/lib/rdoc/markup/blank_line.rb +1 -1
- data/lib/rdoc/markup/block_quote.rb +1 -1
- data/lib/rdoc/markup/document.rb +1 -1
- data/lib/rdoc/markup/formatter.rb +25 -24
- data/lib/rdoc/markup/hard_break.rb +1 -1
- data/lib/rdoc/markup/heading.rb +4 -4
- data/lib/rdoc/markup/include.rb +1 -1
- data/lib/rdoc/markup/indented_paragraph.rb +1 -1
- data/lib/rdoc/markup/list.rb +1 -1
- data/lib/rdoc/markup/list_item.rb +1 -1
- data/lib/rdoc/markup/paragraph.rb +1 -1
- data/lib/rdoc/markup/parser.rb +79 -47
- data/lib/rdoc/markup/pre_process.rb +11 -6
- data/lib/rdoc/markup/raw.rb +1 -1
- data/lib/rdoc/markup/regexp_handling.rb +41 -0
- data/lib/rdoc/markup/rule.rb +1 -1
- data/lib/rdoc/markup/to_ansi.rb +1 -1
- data/lib/rdoc/markup/to_bs.rb +4 -4
- data/lib/rdoc/markup/to_html.rb +68 -26
- data/lib/rdoc/markup/to_html_crossref.rb +41 -26
- data/lib/rdoc/markup/to_html_snippet.rb +10 -10
- data/lib/rdoc/markup/to_joined_paragraph.rb +7 -32
- data/lib/rdoc/markup/to_label.rb +10 -10
- data/lib/rdoc/markup/to_markdown.rb +9 -9
- data/lib/rdoc/markup/to_rdoc.rb +35 -7
- data/lib/rdoc/markup/to_table_of_contents.rb +2 -1
- data/lib/rdoc/markup/to_test.rb +1 -1
- data/lib/rdoc/markup/to_tt_only.rb +3 -3
- data/lib/rdoc/markup/verbatim.rb +1 -1
- data/lib/rdoc/markup.rb +14 -17
- data/lib/rdoc/meta_method.rb +1 -1
- data/lib/rdoc/method_attr.rb +2 -2
- data/lib/rdoc/mixin.rb +1 -1
- data/lib/rdoc/normal_class.rb +3 -3
- data/lib/rdoc/normal_module.rb +1 -1
- data/lib/rdoc/options.rb +79 -21
- data/lib/rdoc/parser/c.rb +147 -194
- data/lib/rdoc/parser/changelog.rb +150 -19
- data/lib/rdoc/parser/markdown.rb +1 -1
- data/lib/rdoc/parser/rd.rb +1 -1
- data/lib/rdoc/parser/ripper_state_lex.rb +590 -0
- data/lib/rdoc/parser/ruby.rb +632 -466
- data/lib/rdoc/parser/ruby_tools.rb +33 -34
- data/lib/rdoc/parser/simple.rb +3 -3
- data/lib/rdoc/parser/text.rb +1 -1
- data/lib/rdoc/parser.rb +9 -34
- data/lib/rdoc/rd/block_parser.rb +47 -46
- data/lib/rdoc/rd/block_parser.ry +2 -2
- data/lib/rdoc/rd/inline.rb +5 -5
- data/lib/rdoc/rd/inline_parser.rb +139 -138
- data/lib/rdoc/rd/inline_parser.ry +1 -1
- data/lib/rdoc/rd.rb +1 -1
- data/lib/rdoc/rdoc.rb +54 -41
- data/lib/rdoc/require.rb +1 -1
- data/lib/rdoc/ri/driver.rb +132 -42
- data/lib/rdoc/ri/formatter.rb +1 -1
- data/lib/rdoc/ri/paths.rb +4 -18
- data/lib/rdoc/ri/store.rb +1 -1
- data/lib/rdoc/ri/task.rb +2 -2
- data/lib/rdoc/ri.rb +1 -1
- data/lib/rdoc/rubygems_hook.rb +3 -3
- data/lib/rdoc/servlet.rb +21 -12
- data/lib/rdoc/single_class.rb +1 -1
- data/lib/rdoc/stats/normal.rb +24 -18
- data/lib/rdoc/stats/quiet.rb +1 -1
- data/lib/rdoc/stats/verbose.rb +1 -1
- data/lib/rdoc/stats.rb +1 -1
- data/lib/rdoc/store.rb +38 -27
- data/lib/rdoc/task.rb +2 -2
- data/lib/rdoc/text.rb +16 -21
- data/lib/rdoc/token_stream.rb +56 -33
- data/lib/rdoc/tom_doc.rb +17 -12
- data/lib/rdoc/top_level.rb +9 -3
- data/lib/rdoc/version.rb +8 -0
- data/lib/rdoc.rb +24 -10
- data/man/ri.1 +247 -0
- data/rdoc.gemspec +206 -15
- metadata +15 -64
- data/.document +0 -5
- data/.gitignore +0 -13
- data/.travis.yml +0 -24
- data/lib/gauntlet_rdoc.rb +0 -82
- data/lib/rdoc/generator/template/darkfish/js/jquery.js +0 -4
- data/lib/rdoc/markup/formatter_test_case.rb +0 -764
- data/lib/rdoc/markup/inline.rb +0 -2
- data/lib/rdoc/markup/special.rb +0 -41
- data/lib/rdoc/markup/text_formatter_test_case.rb +0 -115
- data/lib/rdoc/ruby_lex.rb +0 -1367
- data/lib/rdoc/ruby_token.rb +0 -461
- data/lib/rdoc/test_case.rb +0 -204
data/lib/rdoc/markup/inline.rb
DELETED
data/lib/rdoc/markup/special.rb
DELETED
@@ -1,41 +0,0 @@
|
|
1
|
-
# frozen_string_literal: false
|
2
|
-
##
|
3
|
-
# Hold details of a special sequence
|
4
|
-
|
5
|
-
class RDoc::Markup::Special
|
6
|
-
|
7
|
-
##
|
8
|
-
# Special type
|
9
|
-
|
10
|
-
attr_reader :type
|
11
|
-
|
12
|
-
##
|
13
|
-
# Special text
|
14
|
-
|
15
|
-
attr_accessor :text
|
16
|
-
|
17
|
-
##
|
18
|
-
# Creates a new special sequence of +type+ with +text+
|
19
|
-
|
20
|
-
def initialize(type, text)
|
21
|
-
@type, @text = type, text
|
22
|
-
end
|
23
|
-
|
24
|
-
##
|
25
|
-
# Specials are equal when the have the same text and type
|
26
|
-
|
27
|
-
def ==(o)
|
28
|
-
self.text == o.text && self.type == o.type
|
29
|
-
end
|
30
|
-
|
31
|
-
def inspect # :nodoc:
|
32
|
-
"#<RDoc::Markup::Special:0x%x @type=%p, @text=%p>" % [
|
33
|
-
object_id, @type, text.dump]
|
34
|
-
end
|
35
|
-
|
36
|
-
def to_s # :nodoc:
|
37
|
-
"Special: type=#{type} text=#{text.dump}"
|
38
|
-
end
|
39
|
-
|
40
|
-
end
|
41
|
-
|
@@ -1,115 +0,0 @@
|
|
1
|
-
# frozen_string_literal: false
|
2
|
-
##
|
3
|
-
# Test case for creating new plain-text RDoc::Markup formatters. See also
|
4
|
-
# RDoc::Markup::FormatterTestCase
|
5
|
-
#
|
6
|
-
# See test_rdoc_markup_to_rdoc.rb for a complete example.
|
7
|
-
#
|
8
|
-
# Example:
|
9
|
-
#
|
10
|
-
# class TestRDocMarkupToNewTextFormat < RDoc::Markup::TextFormatterTestCase
|
11
|
-
#
|
12
|
-
# add_visitor_tests
|
13
|
-
# add_text_tests
|
14
|
-
#
|
15
|
-
# def setup
|
16
|
-
# super
|
17
|
-
#
|
18
|
-
# @to = RDoc::Markup::ToNewTextFormat.new
|
19
|
-
# end
|
20
|
-
#
|
21
|
-
# def accept_blank_line
|
22
|
-
# assert_equal :junk, @to.res.join
|
23
|
-
# end
|
24
|
-
#
|
25
|
-
# # ...
|
26
|
-
#
|
27
|
-
# end
|
28
|
-
|
29
|
-
class RDoc::Markup::TextFormatterTestCase < RDoc::Markup::FormatterTestCase
|
30
|
-
|
31
|
-
##
|
32
|
-
# Adds test cases to the calling TestCase.
|
33
|
-
|
34
|
-
def self.add_text_tests
|
35
|
-
self.class_eval do
|
36
|
-
|
37
|
-
##
|
38
|
-
# Test case that calls <tt>@to.accept_heading</tt>
|
39
|
-
|
40
|
-
def test_accept_heading_indent
|
41
|
-
@to.start_accepting
|
42
|
-
@to.indent = 3
|
43
|
-
@to.accept_heading @RM::Heading.new(1, 'Hello')
|
44
|
-
|
45
|
-
accept_heading_indent
|
46
|
-
end
|
47
|
-
|
48
|
-
##
|
49
|
-
# Test case that calls <tt>@to.accept_rule</tt>
|
50
|
-
|
51
|
-
def test_accept_rule_indent
|
52
|
-
@to.start_accepting
|
53
|
-
@to.indent = 3
|
54
|
-
@to.accept_rule @RM::Rule.new(1)
|
55
|
-
|
56
|
-
accept_rule_indent
|
57
|
-
end
|
58
|
-
|
59
|
-
##
|
60
|
-
# Test case that calls <tt>@to.accept_verbatim</tt>
|
61
|
-
|
62
|
-
def test_accept_verbatim_indent
|
63
|
-
@to.start_accepting
|
64
|
-
@to.indent = 2
|
65
|
-
@to.accept_verbatim @RM::Verbatim.new("hi\n", " world\n")
|
66
|
-
|
67
|
-
accept_verbatim_indent
|
68
|
-
end
|
69
|
-
|
70
|
-
##
|
71
|
-
# Test case that calls <tt>@to.accept_verbatim</tt> with a big indent
|
72
|
-
|
73
|
-
def test_accept_verbatim_big_indent
|
74
|
-
@to.start_accepting
|
75
|
-
@to.indent = 2
|
76
|
-
@to.accept_verbatim @RM::Verbatim.new("hi\n", "world\n")
|
77
|
-
|
78
|
-
accept_verbatim_big_indent
|
79
|
-
end
|
80
|
-
|
81
|
-
##
|
82
|
-
# Test case that calls <tt>@to.accept_paragraph</tt> with an indent
|
83
|
-
|
84
|
-
def test_accept_paragraph_indent
|
85
|
-
@to.start_accepting
|
86
|
-
@to.indent = 3
|
87
|
-
@to.accept_paragraph @RM::Paragraph.new(('words ' * 30).strip)
|
88
|
-
|
89
|
-
accept_paragraph_indent
|
90
|
-
end
|
91
|
-
|
92
|
-
##
|
93
|
-
# Test case that calls <tt>@to.accept_paragraph</tt> with a long line
|
94
|
-
|
95
|
-
def test_accept_paragraph_wrap
|
96
|
-
@to.start_accepting
|
97
|
-
@to.accept_paragraph @RM::Paragraph.new(('words ' * 30).strip)
|
98
|
-
|
99
|
-
accept_paragraph_wrap
|
100
|
-
end
|
101
|
-
|
102
|
-
##
|
103
|
-
# Test case that calls <tt>@to.attributes</tt> with an escaped
|
104
|
-
# cross-reference. If this test doesn't pass something may be very
|
105
|
-
# wrong.
|
106
|
-
|
107
|
-
def test_attributes
|
108
|
-
assert_equal 'Dog', @to.attributes("\\Dog")
|
109
|
-
end
|
110
|
-
|
111
|
-
end
|
112
|
-
end
|
113
|
-
|
114
|
-
end
|
115
|
-
|