rdoc 6.14.2 → 7.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CONTRIBUTING.md +196 -0
- data/History.rdoc +1 -1
- data/LEGAL.rdoc +6 -0
- data/README.md +129 -0
- data/RI.md +1 -1
- data/lib/rdoc/code_object/any_method.rb +15 -7
- data/lib/rdoc/code_object/class_module.rb +38 -8
- data/lib/rdoc/code_object/constant.rb +9 -0
- data/lib/rdoc/code_object/method_attr.rb +13 -1
- data/lib/rdoc/code_object/top_level.rb +31 -26
- data/lib/rdoc/comment.rb +190 -8
- data/lib/rdoc/cross_reference.rb +1 -1
- data/lib/rdoc/generator/aliki.rb +183 -0
- data/lib/rdoc/generator/darkfish.rb +8 -2
- data/lib/rdoc/generator/template/aliki/_aside_toc.rhtml +8 -0
- data/lib/rdoc/generator/template/aliki/_footer.rhtml +23 -0
- data/lib/rdoc/generator/template/aliki/_head.rhtml +158 -0
- data/lib/rdoc/generator/template/aliki/_header.rhtml +56 -0
- data/lib/rdoc/generator/template/aliki/_icons.rhtml +208 -0
- data/lib/rdoc/generator/template/aliki/_sidebar_ancestors.rhtml +16 -0
- data/lib/rdoc/generator/template/aliki/_sidebar_classes.rhtml +15 -0
- data/lib/rdoc/generator/template/aliki/_sidebar_extends.rhtml +25 -0
- data/lib/rdoc/generator/template/aliki/_sidebar_includes.rhtml +25 -0
- data/lib/rdoc/generator/template/aliki/_sidebar_installed.rhtml +16 -0
- data/lib/rdoc/generator/template/aliki/_sidebar_methods.rhtml +41 -0
- data/lib/rdoc/generator/template/aliki/_sidebar_pages.rhtml +67 -0
- data/lib/rdoc/generator/template/aliki/_sidebar_search.rhtml +15 -0
- data/lib/rdoc/generator/template/aliki/_sidebar_sections.rhtml +21 -0
- data/lib/rdoc/generator/template/aliki/_sidebar_toggle.rhtml +3 -0
- data/lib/rdoc/generator/template/aliki/class.rhtml +218 -0
- data/lib/rdoc/generator/template/aliki/css/rdoc.css +1943 -0
- data/lib/rdoc/generator/template/aliki/index.rhtml +22 -0
- data/lib/rdoc/generator/template/aliki/js/aliki.js +505 -0
- data/lib/rdoc/generator/template/aliki/js/c_highlighter.js +299 -0
- data/lib/rdoc/generator/template/aliki/js/search_controller.js +129 -0
- data/lib/rdoc/generator/template/aliki/js/search_navigation.js +105 -0
- data/lib/rdoc/generator/template/aliki/js/search_ranker.js +239 -0
- data/lib/rdoc/generator/template/aliki/js/theme-toggle.js +112 -0
- data/lib/rdoc/generator/template/aliki/page.rhtml +18 -0
- data/lib/rdoc/generator/template/aliki/servlet_not_found.rhtml +14 -0
- data/lib/rdoc/generator/template/aliki/servlet_root.rhtml +65 -0
- data/lib/rdoc/generator/template/darkfish/_footer.rhtml +3 -3
- data/lib/rdoc/generator/template/darkfish/_head.rhtml +14 -19
- data/lib/rdoc/generator/template/darkfish/_sidebar_extends.rhtml +8 -8
- data/lib/rdoc/generator/template/darkfish/_sidebar_includes.rhtml +8 -8
- data/lib/rdoc/generator/template/darkfish/_sidebar_installed.rhtml +7 -6
- data/lib/rdoc/generator/template/darkfish/_sidebar_methods.rhtml +6 -6
- data/lib/rdoc/generator/template/darkfish/_sidebar_pages.rhtml +18 -18
- data/lib/rdoc/generator/template/darkfish/_sidebar_parent.rhtml +2 -2
- data/lib/rdoc/generator/template/darkfish/_sidebar_search.rhtml +1 -0
- data/lib/rdoc/generator/template/darkfish/_sidebar_sections.rhtml +3 -3
- data/lib/rdoc/generator/template/darkfish/_sidebar_table_of_contents.rhtml +14 -14
- data/lib/rdoc/generator/template/darkfish/class.rhtml +68 -68
- data/lib/rdoc/generator/template/darkfish/index.rhtml +4 -3
- data/lib/rdoc/generator/template/darkfish/js/darkfish.js +21 -1
- data/lib/rdoc/generator/template/darkfish/js/search.js +11 -1
- data/lib/rdoc/generator/template/darkfish/page.rhtml +2 -1
- data/lib/rdoc/generator/template/darkfish/servlet_not_found.rhtml +2 -1
- data/lib/rdoc/generator/template/darkfish/servlet_root.rhtml +19 -19
- data/lib/rdoc/generator/template/darkfish/table_of_contents.rhtml +19 -17
- data/lib/rdoc/generator/template/json_index/js/searcher.js +48 -6
- data/lib/rdoc/generator.rb +1 -0
- data/lib/rdoc/markdown.kpeg +28 -17
- data/lib/rdoc/markdown.rb +365 -544
- data/lib/rdoc/markup/blank_line.rb +25 -23
- data/lib/rdoc/markup/element.rb +21 -0
- data/lib/rdoc/markup/hard_break.rb +30 -27
- data/lib/rdoc/markup/heading.rb +96 -79
- data/lib/rdoc/markup/pre_process.rb +34 -10
- data/lib/rdoc/markup/raw.rb +52 -55
- data/lib/rdoc/markup/table.rb +48 -40
- data/lib/rdoc/markup/to_ansi.rb +4 -0
- data/lib/rdoc/markup/to_bs.rb +4 -0
- data/lib/rdoc/markup/to_html.rb +162 -14
- data/lib/rdoc/markup/to_html_crossref.rb +53 -23
- data/lib/rdoc/markup/to_rdoc.rb +11 -3
- data/lib/rdoc/markup.rb +1 -0
- data/lib/rdoc/options.rb +22 -11
- data/lib/rdoc/parser/c.rb +15 -46
- data/lib/rdoc/parser/prism_ruby.rb +121 -113
- data/lib/rdoc/parser/ruby.rb +8 -8
- data/lib/rdoc/parser/ruby_tools.rb +5 -7
- data/lib/rdoc/parser/simple.rb +4 -21
- data/lib/rdoc/rdoc.rb +1 -0
- data/lib/rdoc/ri/task.rb +2 -2
- data/lib/rdoc/rubygems_hook.rb +3 -3
- data/lib/rdoc/store.rb +2 -2
- data/lib/rdoc/task.rb +4 -4
- data/lib/rdoc/text.rb +1 -1
- data/lib/rdoc/token_stream.rb +13 -1
- data/lib/rdoc/tom_doc.rb +1 -1
- data/lib/rdoc/version.rb +1 -1
- data/rdoc.gemspec +4 -3
- metadata +51 -8
- data/CONTRIBUTING.rdoc +0 -219
- data/README.rdoc +0 -144
data/lib/rdoc/markdown.kpeg
CHANGED
|
@@ -497,6 +497,17 @@
|
|
|
497
497
|
end
|
|
498
498
|
end
|
|
499
499
|
|
|
500
|
+
##
|
|
501
|
+
# Wraps `text` in code markup for rdoc inline formatting
|
|
502
|
+
|
|
503
|
+
def code text
|
|
504
|
+
# trim even spaces
|
|
505
|
+
text = $2 while /\A( +|\t+)(.*)\1\z/ =~ text
|
|
506
|
+
# escape unescaped backslash at the end
|
|
507
|
+
backslash_at_end = "\\" if /(?<!\\)(?:\\\\)*\\\z/.match?(text)
|
|
508
|
+
"<code>#{text}#{backslash_at_end}</code>"
|
|
509
|
+
end
|
|
510
|
+
|
|
500
511
|
##
|
|
501
512
|
# Parses inline markdown in table cells
|
|
502
513
|
|
|
@@ -1104,32 +1115,32 @@ Ticks3 = "```" !"`"
|
|
|
1104
1115
|
Ticks4 = "````" !"`"
|
|
1105
1116
|
Ticks5 = "`````" !"`"
|
|
1106
1117
|
|
|
1107
|
-
Code = ( Ticks1
|
|
1118
|
+
Code = ( Ticks1 < (
|
|
1108
1119
|
( !"`" Nonspacechar )+ | !Ticks1 /`+/ |
|
|
1109
|
-
!
|
|
1110
|
-
)+ >
|
|
1111
|
-
Ticks2
|
|
1120
|
+
!Ticks1 ( @Spacechar | @Newline !@BlankLine )
|
|
1121
|
+
)+ > Ticks1 |
|
|
1122
|
+
Ticks2 < (
|
|
1112
1123
|
( !"`" Nonspacechar )+ |
|
|
1113
1124
|
!Ticks2 /`+/ |
|
|
1114
|
-
!
|
|
1115
|
-
)+ >
|
|
1116
|
-
Ticks3
|
|
1125
|
+
!Ticks2 ( @Spacechar | @Newline !@BlankLine )
|
|
1126
|
+
)+ > Ticks2 |
|
|
1127
|
+
Ticks3 < (
|
|
1117
1128
|
( !"`" Nonspacechar )+ |
|
|
1118
1129
|
!Ticks3 /`+/ |
|
|
1119
|
-
!
|
|
1120
|
-
)+ >
|
|
1121
|
-
Ticks4
|
|
1130
|
+
!Ticks3 ( @Spacechar | @Newline !@BlankLine )
|
|
1131
|
+
)+ > Ticks3 |
|
|
1132
|
+
Ticks4 < (
|
|
1122
1133
|
( !"`" Nonspacechar )+ |
|
|
1123
1134
|
!Ticks4 /`+/ |
|
|
1124
|
-
!
|
|
1125
|
-
)+ >
|
|
1126
|
-
Ticks5
|
|
1135
|
+
!Ticks4 ( @Spacechar | @Newline !@BlankLine )
|
|
1136
|
+
)+ > Ticks4 |
|
|
1137
|
+
Ticks5 < (
|
|
1127
1138
|
( !"`" Nonspacechar )+ |
|
|
1128
1139
|
!Ticks5 /`+/ |
|
|
1129
|
-
!
|
|
1130
|
-
)+ >
|
|
1140
|
+
!Ticks5 ( @Spacechar | @Newline !@BlankLine )
|
|
1141
|
+
)+ > Ticks5
|
|
1131
1142
|
)
|
|
1132
|
-
{
|
|
1143
|
+
{ code text }
|
|
1133
1144
|
|
|
1134
1145
|
RawHtml = < (HtmlComment | HtmlBlockScript | HtmlTag) >
|
|
1135
1146
|
{ if html? then text else '' end }
|
|
@@ -1253,7 +1264,7 @@ TableRow = ( ( TableItem:item1 TableItem2*:items { [item1, *items] } ):row | Tab
|
|
|
1253
1264
|
{ row }
|
|
1254
1265
|
TableItem2 = "|" TableItem
|
|
1255
1266
|
TableItem = < /(?:\\.|[^|\n])+/ >
|
|
1256
|
-
{ text.strip.gsub(/\\(
|
|
1267
|
+
{ text.strip.gsub(/\\([|])/, '\1') }
|
|
1257
1268
|
|
|
1258
1269
|
TableLine = ( ( TableAlign:align1 TableAlign2*:aligns {[align1, *aligns] } ):line | TableAlign2+:line ) "|"? @Newline
|
|
1259
1270
|
{ line }
|