distil 0.12.6 → 0.13.0
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.
- data/Rakefile +13 -1
- data/VERSION +1 -1
- data/bin/distil +21 -13
- data/distil.gemspec +27 -4
- data/distil.tmproj +4 -125
- data/lib/distil/configurable.rb +1 -0
- data/lib/distil/product/javascript-product.rb +2 -1
- data/lib/distil/product/pdoc-product.rb +42 -0
- data/lib/distil/product.rb +1 -0
- data/lib/distil/source-file.rb +3 -5
- data/lib/distil/target.rb +6 -3
- data/lib/distil/task.rb +1 -1
- data/lib/distil.rb +14 -14
- data/vendor/pdoc/Rakefile +3 -3
- data/vendor/pdoc-template/assets/stylesheets/api.css +693 -0
- data/vendor/pdoc-template/assets/stylesheets/core.css +84 -0
- data/vendor/pdoc-template/assets/stylesheets/pygments.css +62 -0
- data/vendor/pdoc-template/assets/stylesheets/reset.css +70 -0
- data/vendor/pdoc-template/assets/stylesheets/syntax.css +60 -0
- data/vendor/pdoc-template/helpers.rb +35 -0
- data/vendor/pdoc-template/index.erb +24 -0
- data/vendor/pdoc-template/item_index.js.erb +6 -0
- data/vendor/pdoc-template/layout.erb +28 -0
- data/vendor/pdoc-template/leaf.erb +22 -0
- data/vendor/pdoc-template/node.erb +64 -0
- data/vendor/pdoc-template/partials/class_relationships.erb +19 -0
- data/vendor/pdoc-template/partials/classes.erb +7 -0
- data/vendor/pdoc-template/partials/constructor.erb +5 -0
- data/vendor/pdoc-template/partials/link_list.erb +1 -0
- data/vendor/pdoc-template/partials/method_signatures.erb +14 -0
- data/vendor/pdoc-template/partials/methodized_note.erb +9 -0
- data/vendor/pdoc-template/partials/namespaces.erb +7 -0
- data/vendor/pdoc-template/partials/related_utilities.erb +5 -0
- data/vendor/pdoc-template/partials/relationships.erb +11 -0
- data/vendor/pdoc-template/partials/short_description_list.erb +7 -0
- data/vendor/pdoc-template/partials/title.erb +22 -0
- data/vendor/pdoc-template/section.erb +22 -0
- metadata +30 -7
- data/vendor/pdoc/pdoc-0.2.0.gem +0 -0
@@ -0,0 +1,84 @@
|
|
1
|
+
/* The "section" class implicitly needs a clearfix; adding it here for convenience. */
|
2
|
+
|
3
|
+
.clearfix:after {
|
4
|
+
content: ".";
|
5
|
+
display: block;
|
6
|
+
clear: both;
|
7
|
+
visibility: hidden;
|
8
|
+
line-height: 0;
|
9
|
+
height: 0;
|
10
|
+
}
|
11
|
+
|
12
|
+
* html .clearfix {
|
13
|
+
height: 1%;
|
14
|
+
}
|
15
|
+
|
16
|
+
body {
|
17
|
+
font-family: Verdana, sans-serif;
|
18
|
+
font-size: 16px;
|
19
|
+
line-height: 22px;
|
20
|
+
margin: 1em;
|
21
|
+
padding: 0;
|
22
|
+
}
|
23
|
+
|
24
|
+
h1, h2, h3, h4, h5, h6 {
|
25
|
+
font-family: "Helvetica Neue", Arial, Helvetica, sans-serif;
|
26
|
+
}
|
27
|
+
|
28
|
+
h1 {
|
29
|
+
font-size: 28px;
|
30
|
+
margin-top: 16px;
|
31
|
+
}
|
32
|
+
|
33
|
+
h2 {
|
34
|
+
font-size: 24px;
|
35
|
+
margin-top: 20px;
|
36
|
+
}
|
37
|
+
|
38
|
+
h3 {
|
39
|
+
font-size: 20px;
|
40
|
+
margin-top: 24px;
|
41
|
+
}
|
42
|
+
|
43
|
+
h4 {
|
44
|
+
font-size: 18px;
|
45
|
+
font-weight: bold;
|
46
|
+
}
|
47
|
+
|
48
|
+
pre {
|
49
|
+
white-space: pre-wrap; /* CSS 3 */
|
50
|
+
white-space: -moz-pre-wrap; /* Mozilla, since 1999 */
|
51
|
+
white-space: -pre-wrap; /* Opera 4-6 */
|
52
|
+
white-space: -o-pre-wrap; /* Opera 7 */
|
53
|
+
word-wrap: break-word; /* Internet Explorer 5.5+ */
|
54
|
+
}
|
55
|
+
|
56
|
+
.breadcrumbs li
|
57
|
+
{
|
58
|
+
display: inline-block;
|
59
|
+
}
|
60
|
+
|
61
|
+
.method-list > li
|
62
|
+
{
|
63
|
+
margin-top: 22px;
|
64
|
+
}
|
65
|
+
|
66
|
+
.section-constructor h4
|
67
|
+
{
|
68
|
+
margin-top: 22px;
|
69
|
+
}
|
70
|
+
|
71
|
+
#footer
|
72
|
+
{
|
73
|
+
margin-top: 44px;
|
74
|
+
}
|
75
|
+
|
76
|
+
.argument-list
|
77
|
+
{
|
78
|
+
margin-left: 1em;
|
79
|
+
}
|
80
|
+
|
81
|
+
.menu-items li > ul
|
82
|
+
{
|
83
|
+
margin-left: 1em;
|
84
|
+
}
|
@@ -0,0 +1,62 @@
|
|
1
|
+
.highlight .hll { background-color: #ffffcc }
|
2
|
+
.highlight { background: #f8f8f8; }
|
3
|
+
.highlight .c { color: #408080; font-style: italic } /* Comment */
|
4
|
+
.highlight .err { border: 1px solid #FF0000 } /* Error */
|
5
|
+
.highlight .k { color: #008000; font-weight: bold } /* Keyword */
|
6
|
+
.highlight .o { color: #666666 } /* Operator */
|
7
|
+
.highlight .cm { color: #408080; font-style: italic } /* Comment.Multiline */
|
8
|
+
.highlight .cp { color: #BC7A00 } /* Comment.Preproc */
|
9
|
+
.highlight .c1 { color: #408080; font-style: italic } /* Comment.Single */
|
10
|
+
.highlight .cs { color: #408080; font-style: italic } /* Comment.Special */
|
11
|
+
.highlight .gd { color: #A00000 } /* Generic.Deleted */
|
12
|
+
.highlight .ge { font-style: italic } /* Generic.Emph */
|
13
|
+
.highlight .gr { color: #FF0000 } /* Generic.Error */
|
14
|
+
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
|
15
|
+
.highlight .gi { color: #00A000 } /* Generic.Inserted */
|
16
|
+
.highlight .go { color: #808080 } /* Generic.Output */
|
17
|
+
.highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */
|
18
|
+
.highlight .gs { font-weight: bold } /* Generic.Strong */
|
19
|
+
.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
|
20
|
+
.highlight .gt { color: #0040D0 } /* Generic.Traceback */
|
21
|
+
.highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */
|
22
|
+
.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */
|
23
|
+
.highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */
|
24
|
+
.highlight .kp { color: #008000 } /* Keyword.Pseudo */
|
25
|
+
.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */
|
26
|
+
.highlight .kt { color: #B00040 } /* Keyword.Type */
|
27
|
+
.highlight .m { color: #666666 } /* Literal.Number */
|
28
|
+
.highlight .s { color: #BA2121 } /* Literal.String */
|
29
|
+
.highlight .na { color: #7D9029 } /* Name.Attribute */
|
30
|
+
.highlight .nb { color: #008000 } /* Name.Builtin */
|
31
|
+
.highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */
|
32
|
+
.highlight .no { color: #880000 } /* Name.Constant */
|
33
|
+
.highlight .nd { color: #AA22FF } /* Name.Decorator */
|
34
|
+
.highlight .ni { color: #999999; font-weight: bold } /* Name.Entity */
|
35
|
+
.highlight .ne { color: #D2413A; font-weight: bold } /* Name.Exception */
|
36
|
+
.highlight .nf { color: #0000FF } /* Name.Function */
|
37
|
+
.highlight .nl { color: #A0A000 } /* Name.Label */
|
38
|
+
.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */
|
39
|
+
.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */
|
40
|
+
.highlight .nv { color: #19177C } /* Name.Variable */
|
41
|
+
.highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */
|
42
|
+
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
|
43
|
+
.highlight .mf { color: #666666 } /* Literal.Number.Float */
|
44
|
+
.highlight .mh { color: #666666 } /* Literal.Number.Hex */
|
45
|
+
.highlight .mi { color: #666666 } /* Literal.Number.Integer */
|
46
|
+
.highlight .mo { color: #666666 } /* Literal.Number.Oct */
|
47
|
+
.highlight .sb { color: #BA2121 } /* Literal.String.Backtick */
|
48
|
+
.highlight .sc { color: #BA2121 } /* Literal.String.Char */
|
49
|
+
.highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */
|
50
|
+
.highlight .s2 { color: #BA2121 } /* Literal.String.Double */
|
51
|
+
.highlight .se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */
|
52
|
+
.highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */
|
53
|
+
.highlight .si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */
|
54
|
+
.highlight .sx { color: #008000 } /* Literal.String.Other */
|
55
|
+
.highlight .sr { color: #BB6688 } /* Literal.String.Regex */
|
56
|
+
.highlight .s1 { color: #BA2121 } /* Literal.String.Single */
|
57
|
+
.highlight .ss { color: #19177C } /* Literal.String.Symbol */
|
58
|
+
.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */
|
59
|
+
.highlight .vc { color: #19177C } /* Name.Variable.Class */
|
60
|
+
.highlight .vg { color: #19177C } /* Name.Variable.Global */
|
61
|
+
.highlight .vi { color: #19177C } /* Name.Variable.Instance */
|
62
|
+
.highlight .il { color: #666666 } /* Literal.Number.Integer.Long */
|
@@ -0,0 +1,70 @@
|
|
1
|
+
/* http://meyerweb.com/eric/tools/css/reset/ */
|
2
|
+
/* v1.0 | 20080212 */
|
3
|
+
|
4
|
+
html, body, div, span, applet, object, iframe,
|
5
|
+
h1, h2, h3, h4, h5, h6, p, blockquote, pre,
|
6
|
+
a, abbr, acronym, address, big, cite, code,
|
7
|
+
del, dfn, em, font, img, ins, kbd, q, s, samp,
|
8
|
+
small, strike, strong, sub, sup, tt, var,
|
9
|
+
b, u, i, center,
|
10
|
+
dl, dt, dd, ol, ul, li,
|
11
|
+
fieldset, form, label, legend,
|
12
|
+
table, caption, tbody, tfoot, thead, tr, th, td {
|
13
|
+
margin: 0;
|
14
|
+
padding: 0;
|
15
|
+
border: 0;
|
16
|
+
outline: 0;
|
17
|
+
font-size: 100%;
|
18
|
+
vertical-align: baseline;
|
19
|
+
background: transparent;
|
20
|
+
font-weight: normal;
|
21
|
+
font-style: normal;
|
22
|
+
}
|
23
|
+
em, i
|
24
|
+
{
|
25
|
+
font-style: normal;
|
26
|
+
}
|
27
|
+
b, strong
|
28
|
+
{
|
29
|
+
font-weight: normal;
|
30
|
+
}
|
31
|
+
|
32
|
+
a:focus, a:active, button:focus, button:active
|
33
|
+
{
|
34
|
+
outline: 0;
|
35
|
+
}
|
36
|
+
button::-moz-focus-inner { border: 0; }
|
37
|
+
|
38
|
+
body {
|
39
|
+
line-height: 1;
|
40
|
+
}
|
41
|
+
ol, ul {
|
42
|
+
list-style: none;
|
43
|
+
}
|
44
|
+
blockquote, q {
|
45
|
+
quotes: none;
|
46
|
+
}
|
47
|
+
blockquote:before, blockquote:after,
|
48
|
+
q:before, q:after {
|
49
|
+
content: '';
|
50
|
+
content: none;
|
51
|
+
}
|
52
|
+
|
53
|
+
/* remember to define focus styles! */
|
54
|
+
/*:focus {
|
55
|
+
outline: 0;
|
56
|
+
}
|
57
|
+
*/
|
58
|
+
/* remember to highlight inserts somehow! */
|
59
|
+
ins {
|
60
|
+
text-decoration: none;
|
61
|
+
}
|
62
|
+
del {
|
63
|
+
text-decoration: line-through;
|
64
|
+
}
|
65
|
+
|
66
|
+
/* tables still need 'cellspacing="0"' in the markup */
|
67
|
+
table {
|
68
|
+
border-collapse: collapse;
|
69
|
+
border-spacing: 0;
|
70
|
+
}
|
@@ -0,0 +1,60 @@
|
|
1
|
+
.highlight { background: #ffffff; }
|
2
|
+
.highlight .c { color: #999988; font-style: italic } /* Comment */
|
3
|
+
.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
|
4
|
+
.highlight .k { font-weight: bold } /* Keyword */
|
5
|
+
.highlight .o { font-weight: bold } /* Operator */
|
6
|
+
.highlight .cm { color: #999988; font-style: italic } /* Comment.Multiline */
|
7
|
+
.highlight .cp { color: #999999; font-weight: bold } /* Comment.Preproc */
|
8
|
+
.highlight .c1 { color: #999988; font-style: italic } /* Comment.Single */
|
9
|
+
.highlight .cs { color: #999999; font-weight: bold; font-style: italic } /* Comment.Special */
|
10
|
+
.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
|
11
|
+
.highlight .gd .x { color: #000000; background-color: #ffaaaa } /* Generic.Deleted.Specific */
|
12
|
+
.highlight .ge { font-style: italic } /* Generic.Emph */
|
13
|
+
.highlight .gr { color: #aa0000 } /* Generic.Error */
|
14
|
+
.highlight .gh { color: #999999 } /* Generic.Heading */
|
15
|
+
.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
|
16
|
+
.highlight .gi .x { color: #000000; background-color: #aaffaa } /* Generic.Inserted.Specific */
|
17
|
+
.highlight .go { color: #888888 } /* Generic.Output */
|
18
|
+
.highlight .gp { color: #555555 } /* Generic.Prompt */
|
19
|
+
.highlight .gs { font-weight: bold } /* Generic.Strong */
|
20
|
+
.highlight .gu { color: #aaaaaa } /* Generic.Subheading */
|
21
|
+
.highlight .gt { color: #aa0000 } /* Generic.Traceback */
|
22
|
+
.highlight .kc { font-weight: bold } /* Keyword.Constant */
|
23
|
+
.highlight .kd { font-weight: bold } /* Keyword.Declaration */
|
24
|
+
.highlight .kp { font-weight: bold } /* Keyword.Pseudo */
|
25
|
+
.highlight .kr { font-weight: bold } /* Keyword.Reserved */
|
26
|
+
.highlight .kt { color: #445588; font-weight: bold } /* Keyword.Type */
|
27
|
+
.highlight .m { color: #009999 } /* Literal.Number */
|
28
|
+
.highlight .s { color: #d14 } /* Literal.String */
|
29
|
+
.highlight .na { color: #008080 } /* Name.Attribute */
|
30
|
+
.highlight .nb { color: #0086B3 } /* Name.Builtin */
|
31
|
+
.highlight .nc { color: #445588; font-weight: bold } /* Name.Class */
|
32
|
+
.highlight .no { color: #008080 } /* Name.Constant */
|
33
|
+
.highlight .ni { color: #800080 } /* Name.Entity */
|
34
|
+
.highlight .ne { color: #990000; font-weight: bold } /* Name.Exception */
|
35
|
+
.highlight .nf { color: #990000; font-weight: bold } /* Name.Function */
|
36
|
+
.highlight .nn { color: #555555 } /* Name.Namespace */
|
37
|
+
.highlight .nt { color: #000080 } /* Name.Tag */
|
38
|
+
.highlight .nv { color: #008080 } /* Name.Variable */
|
39
|
+
.highlight .ow { font-weight: bold } /* Operator.Word */
|
40
|
+
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
|
41
|
+
.highlight .mf { color: #009999 } /* Literal.Number.Float */
|
42
|
+
.highlight .mh { color: #009999 } /* Literal.Number.Hex */
|
43
|
+
.highlight .mi { color: #009999 } /* Literal.Number.Integer */
|
44
|
+
.highlight .mo { color: #009999 } /* Literal.Number.Oct */
|
45
|
+
.highlight .sb { color: #d14 } /* Literal.String.Backtick */
|
46
|
+
.highlight .sc { color: #d14 } /* Literal.String.Char */
|
47
|
+
.highlight .sd { color: #d14 } /* Literal.String.Doc */
|
48
|
+
.highlight .s2 { color: #d14 } /* Literal.String.Double */
|
49
|
+
.highlight .se { color: #d14 } /* Literal.String.Escape */
|
50
|
+
.highlight .sh { color: #d14 } /* Literal.String.Heredoc */
|
51
|
+
.highlight .si { color: #d14 } /* Literal.String.Interpol */
|
52
|
+
.highlight .sx { color: #d14 } /* Literal.String.Other */
|
53
|
+
.highlight .sr { color: #009926 } /* Literal.String.Regex */
|
54
|
+
.highlight .s1 { color: #d14 } /* Literal.String.Single */
|
55
|
+
.highlight .ss { color: #990073 } /* Literal.String.Symbol */
|
56
|
+
.highlight .bp { color: #999999 } /* Name.Builtin.Pseudo */
|
57
|
+
.highlight .vc { color: #008080 } /* Name.Variable.Class */
|
58
|
+
.highlight .vg { color: #008080 } /* Name.Variable.Global */
|
59
|
+
.highlight .vi { color: #008080 } /* Name.Variable.Instance */
|
60
|
+
.highlight .il { color: #009999 } /* Literal.Number.Integer.Long */
|
@@ -0,0 +1,35 @@
|
|
1
|
+
module PDoc
|
2
|
+
module Generators
|
3
|
+
module Html
|
4
|
+
module Helpers
|
5
|
+
module BaseHelper
|
6
|
+
def layout_section(title, classname = title.downcase)
|
7
|
+
<<-EOS
|
8
|
+
<div class="section section-#{classname}">
|
9
|
+
<div class="section-title">
|
10
|
+
<h3>#{title}</h3>
|
11
|
+
</div> <!-- .section-title -->
|
12
|
+
<div class="section-content">
|
13
|
+
EOS
|
14
|
+
end
|
15
|
+
|
16
|
+
def end_layout_section
|
17
|
+
<<-EOS
|
18
|
+
</div> <!-- .section-content -->
|
19
|
+
</div> <!-- .section -->
|
20
|
+
EOS
|
21
|
+
end
|
22
|
+
end
|
23
|
+
|
24
|
+
module LinkHelper
|
25
|
+
end
|
26
|
+
|
27
|
+
module CodeHelper
|
28
|
+
end
|
29
|
+
|
30
|
+
module MenuHelper
|
31
|
+
end
|
32
|
+
end
|
33
|
+
end
|
34
|
+
end
|
35
|
+
end
|
@@ -0,0 +1,24 @@
|
|
1
|
+
<% @title = "Home" %>
|
2
|
+
|
3
|
+
<div class="page-introduction">
|
4
|
+
<%= @index_page_content %>
|
5
|
+
</div> <!-- .section -->
|
6
|
+
|
7
|
+
<% if @root.sections? %>
|
8
|
+
|
9
|
+
<%= layout_section('Sections') %>
|
10
|
+
<ul class="section-list">
|
11
|
+
<% @root.sections.each do |section| %>
|
12
|
+
<li>
|
13
|
+
<h4>
|
14
|
+
<a href="<%= path_to(section) %>"><%= section.name %></a>
|
15
|
+
</h4>
|
16
|
+
<p><%= htmlize(section.short_description) %></p>
|
17
|
+
</li>
|
18
|
+
<% end %>
|
19
|
+
</ul>
|
20
|
+
<%= end_layout_section %>
|
21
|
+
|
22
|
+
<% else %>
|
23
|
+
<%= menu(@root) %>
|
24
|
+
<% end %>
|
@@ -0,0 +1,28 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
5
|
+
<title><%= @home && @index_title ? @index_title : "#{@short_name} v#{@version} API documentation | #{@title}" %>
|
6
|
+
<meta name="generator" content="PDoc" />
|
7
|
+
|
8
|
+
<% ["reset", "syntax", "core"].each do |stylesheet| %>
|
9
|
+
<%= stylesheet_link_tag stylesheet %>
|
10
|
+
<% end %>
|
11
|
+
|
12
|
+
</head>
|
13
|
+
<body>
|
14
|
+
|
15
|
+
<div id="page">
|
16
|
+
<%= @home ? @index_header : @header %>
|
17
|
+
|
18
|
+
<div id="main" class="page-content">
|
19
|
+
<%= @content_for_layout %>
|
20
|
+
</div> <!-- #main -->
|
21
|
+
|
22
|
+
<div id="footer">
|
23
|
+
<%= @footer %>
|
24
|
+
</div> <!-- #footer -->
|
25
|
+
|
26
|
+
</div> <!-- #page -->
|
27
|
+
</body>
|
28
|
+
</html>
|
@@ -0,0 +1,22 @@
|
|
1
|
+
<% @title = "#{@doc_instance.full_name} #{@doc_instance.type}" %>
|
2
|
+
|
3
|
+
<%= include "partials/title", :object => @doc_instance %>
|
4
|
+
|
5
|
+
<div class="section">
|
6
|
+
<div class="section-title">
|
7
|
+
</div> <!-- .section-title -->
|
8
|
+
<div class="section-content">
|
9
|
+
<div class="method-description">
|
10
|
+
<% if @doc_instance.respond_to?(:signatures) %>
|
11
|
+
<%= include "partials/method_signatures", :object => @doc_instance %>
|
12
|
+
<% else %>
|
13
|
+
<pre class="syntax"><code class="ebnf"><%= @doc_instance.signature.name %> → <%= auto_link_types(@doc_instance.signature.return_value, :name => :long).join(' | ') %></code></pre>
|
14
|
+
<% end %>
|
15
|
+
|
16
|
+
<%= htmlize(@doc_instance.description) %>
|
17
|
+
|
18
|
+
<%= include "partials/relationships", :object => @doc_instance %>
|
19
|
+
<%= include "partials/methodized_note", :object => @doc_instance %>
|
20
|
+
</div>
|
21
|
+
</div> <!-- .section-content -->
|
22
|
+
</div> <!-- .section -->
|
@@ -0,0 +1,64 @@
|
|
1
|
+
<% d = @doc_instance %>
|
2
|
+
|
3
|
+
<%= include "partials/title", :object => @doc_instance %>
|
4
|
+
|
5
|
+
<% if d.description && !d.description.empty? %>
|
6
|
+
<%= layout_section('Description') %>
|
7
|
+
<%= htmlize(d.description) %>
|
8
|
+
<%= end_layout_section %>
|
9
|
+
<% end %>
|
10
|
+
|
11
|
+
<%= include "partials/namespaces", :object => @doc_instance %>
|
12
|
+
<%= include "partials/classes", :object => @doc_instance %>
|
13
|
+
|
14
|
+
<%= include "partials/class_relationships", :object => @doc_instance %>
|
15
|
+
<%= include "partials/related_utilities", :object => @doc_instance %>
|
16
|
+
|
17
|
+
<% if @doc_instance.respond_to?(:constructor) && @doc_instance.constructor %>
|
18
|
+
<%= layout_section('Constructor') %>
|
19
|
+
<% m= @doc_instance.constructor %>
|
20
|
+
<h4><%= m.full_name %></h4>
|
21
|
+
<% if m.respond_to?(:signatures) %>
|
22
|
+
<%= include "partials/method_signatures", :object => m %>
|
23
|
+
<% else %>
|
24
|
+
<pre class="syntax"><code class="ebnf"><%= m.signature.name %> → <%= auto_link_types(m.signature.return_value, :name => :long).join(' | ') %></code></pre>
|
25
|
+
<% end %>
|
26
|
+
|
27
|
+
<%= htmlize(m.description) %>
|
28
|
+
<%= include "partials/relationships", :object => m %>
|
29
|
+
<%= include "partials/methodized_note", :object => m %>
|
30
|
+
<%= end_layout_section %>
|
31
|
+
<% end %>
|
32
|
+
|
33
|
+
|
34
|
+
<%
|
35
|
+
types = [
|
36
|
+
[:class_methods, 'Class methods'],
|
37
|
+
[:class_properties, 'Class properties'],
|
38
|
+
[:instance_methods, 'Instance methods'],
|
39
|
+
[:instance_properties, 'Instance properties'],
|
40
|
+
[:constants, 'Constants']
|
41
|
+
].each do |a| %>
|
42
|
+
<% method, title = a %>
|
43
|
+
<% methods = @doc_instance.send(method) %>
|
44
|
+
<% unless methods.empty? %>
|
45
|
+
<%= layout_section(title, method) %>
|
46
|
+
<ul class="method-list">
|
47
|
+
<% methods.each do |m| %>
|
48
|
+
<li>
|
49
|
+
<h4><%= m.full_name %></h4>
|
50
|
+
<% if m.respond_to?(:signatures) %>
|
51
|
+
<%= include "partials/method_signatures", :object => m %>
|
52
|
+
<% else %>
|
53
|
+
<pre class="syntax"><code class="ebnf"><%= m.signature.name %> → <%= auto_link_types(m.signature.return_value, :name => :long).join(' | ') %></code></pre>
|
54
|
+
<% end %>
|
55
|
+
|
56
|
+
<%= htmlize(m.description) %>
|
57
|
+
<%= include "partials/relationships", :object => m %>
|
58
|
+
<%= include "partials/methodized_note", :object => m %>
|
59
|
+
</li>
|
60
|
+
<% end %>
|
61
|
+
</ul>
|
62
|
+
<%= end_layout_section %>
|
63
|
+
<% end %>
|
64
|
+
<% end %>
|
@@ -0,0 +1,19 @@
|
|
1
|
+
<% if object.respond_to?(:subclass) %>
|
2
|
+
<% if object.superclass %>
|
3
|
+
<%= layout_section('Superclass') %>
|
4
|
+
<p><%= auto_link_code(object.superclass, :name => :long) %></p>
|
5
|
+
<%= end_layout_section %>
|
6
|
+
<% end %>
|
7
|
+
|
8
|
+
<% if object.subclasses? %>
|
9
|
+
<%= layout_section('Subclasses') %>
|
10
|
+
<p><%= object.subclasses.sort!.map { |s| auto_link_code(s, :name => :long) }.join(', ') %></p>
|
11
|
+
<%= end_layout_section %>
|
12
|
+
<% end %>
|
13
|
+
<% end %>
|
14
|
+
|
15
|
+
<% if object.included_mixins? %>
|
16
|
+
<%= layout_section('Includes', :mixins) %>
|
17
|
+
<p><%= object.included_mixins.sort!.map { |m| auto_link_code(m, :name => :long) }.join(', ') %></p>
|
18
|
+
<%= end_layout_section %>
|
19
|
+
<% end %>
|
@@ -0,0 +1 @@
|
|
1
|
+
<li><%= auto_link_code(object, :name => :short, :class => class_names_for(object)) %></li>
|
@@ -0,0 +1,14 @@
|
|
1
|
+
<pre class="syntax"><code class="ebnf"><%= method_synopsis(object).join('<br />') %></code></pre>
|
2
|
+
<% if object.respond_to?(:arguments) && object.arguments? %>
|
3
|
+
<ul class="argument-list">
|
4
|
+
<% object.arguments.each do |arg| %>
|
5
|
+
<li>
|
6
|
+
<code class="argument-name"><%= arg.name %></code>
|
7
|
+
<% unless arg.types.empty? %>
|
8
|
+
<span class="argument-types">(<%= auto_link_types(arg.types).map { |t| "<code>#{t}</code>"}.join(' | ') %>)</span>
|
9
|
+
<% end %>
|
10
|
+
<%= ' – ' + inline_htmlize(arg.description) unless arg.description.empty? %>
|
11
|
+
</li>
|
12
|
+
<% end %>
|
13
|
+
</ul> <!-- .argument-list -->
|
14
|
+
<% end %>
|
@@ -0,0 +1,9 @@
|
|
1
|
+
<% if object.methodized? %>
|
2
|
+
<p class="note">
|
3
|
+
<% if object.respond_to?(:methodized_self) %>
|
4
|
+
This method can be called <em>either</em> as an <a href="<%= path_to(object.methodized_self) %>">instance method</a> <em>or</em> as a generic method.
|
5
|
+
<% else %>
|
6
|
+
This method can be called <em>either</em> as an instance method <em>or</em> as a <a href="<%= path_to(object.functionalized_self) %>">generic method</a>.
|
7
|
+
<% end %>
|
8
|
+
If calling as a generic, pass the instance in as the first argument.<p>
|
9
|
+
<% end %>
|
@@ -0,0 +1,11 @@
|
|
1
|
+
<% if object.aliases? %>
|
2
|
+
<p class="alias aliases">Aliased as: <%= object.aliases.map.map { |a| auto_link_code(a, :name => :long) }.join(', ') %></p>
|
3
|
+
<% end %>
|
4
|
+
|
5
|
+
<% if object.alias? %>
|
6
|
+
<p class="alias alias-of">Alias of: <%= auto_link_code(object.alias, :name => :long) %></p>
|
7
|
+
<% end %>
|
8
|
+
|
9
|
+
<% if object.respond_to?(:related_to) && related_to = object.related_to %>
|
10
|
+
<p class="related-to">Related to: <%= auto_link_code(related_to, :name => :long) %></p>
|
11
|
+
<% end %>
|
@@ -0,0 +1,22 @@
|
|
1
|
+
<% @title = object.full_name %>
|
2
|
+
|
3
|
+
<% if object.deprecated? %>
|
4
|
+
<div id="deprecated"><%= img_tag('deprecated.png', :alt => "Deprecated", :width => 150, :height => 150) %></div>
|
5
|
+
<% end %>
|
6
|
+
|
7
|
+
<ul class="breadcrumbs clearfix">
|
8
|
+
<li><a href="<%= path_prefix %>">Home</a></li>
|
9
|
+
<% breadcrumb(object, :name => :short).each do |crumb| %>
|
10
|
+
<li>→ <%= crumb %></li>
|
11
|
+
<% end %>
|
12
|
+
</ul>
|
13
|
+
|
14
|
+
<% if object.respond_to?(:src_code_href) && object.src_code_href %>
|
15
|
+
<p id="src_code_href"><a href="<%= object.src_code_href %>">src code</a></p>
|
16
|
+
<% end %>
|
17
|
+
|
18
|
+
<h2 class="page-title">
|
19
|
+
<%= object.full_name %> <span class="type"><%= object.type %></span>
|
20
|
+
</h2>
|
21
|
+
|
22
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
<% @title = "#{@doc_instance.full_name} " %>
|
2
|
+
|
3
|
+
<%= include "partials/title", :object => @doc_instance %>
|
4
|
+
|
5
|
+
<%= layout_section('Description') %>
|
6
|
+
<%= htmlize(@doc_instance.description) %>
|
7
|
+
<%= end_layout_section %>
|
8
|
+
|
9
|
+
<% # Iterate over the items in this section. %>
|
10
|
+
|
11
|
+
<% unless @doc_instance.respond_to?(:utilities) && @doc_instance.utilities? %>
|
12
|
+
<%= layout_section('Utilities') %>
|
13
|
+
<ul class="method-list">
|
14
|
+
<% @doc_instance.utilities.each do |utility| %>
|
15
|
+
<li><%= auto_link_code(utility) %></li>
|
16
|
+
<% end %>
|
17
|
+
</ul>
|
18
|
+
<%= end_layout_section %>
|
19
|
+
<% end %>
|
20
|
+
|
21
|
+
<%= include "partials/namespaces", :object => @doc_instance %>
|
22
|
+
<%= include "partials/classes", :object => @doc_instance %>
|