my_yard 0.0.2 → 0.0.7

Sign up to get free protection for your applications and to get access to all the features.
Files changed (134) hide show
  1. checksums.yaml +5 -5
  2. data/lib/GlobalSettings.rb +23 -0
  3. data/{src → lib}/MyYard.rb +47 -52
  4. data/{src → lib}/YardTheme.rb +12 -9
  5. data/{src → lib}/glade/MyYard.glade +151 -213
  6. data/{src → lib}/glade/YardTheme.glade +314 -407
  7. data/lib/my_yard.rb +7 -0
  8. data/my_yard +59 -34
  9. metadata +21 -147
  10. data/README.md +0 -25
  11. data/doc/GlobalSettings.html +0 -552
  12. data/doc/MyYard.html +0 -1201
  13. data/doc/TreeContext/Alternator.html +0 -297
  14. data/doc/TreeContext.html +0 -467
  15. data/doc/YardTheme.html +0 -746
  16. data/doc/YardThemeDefaults.html +0 -498
  17. data/doc/_index.html +0 -170
  18. data/doc/class_and_method_list.html +0 -322
  19. data/doc/class_list.html +0 -51
  20. data/doc/css/common.css +0 -0
  21. data/doc/css/full_list.css +0 -58
  22. data/doc/css/style.css +0 -474
  23. data/doc/file.README.html +0 -100
  24. data/doc/file_list.html +0 -56
  25. data/doc/frames.html +0 -17
  26. data/doc/img/logo.png +0 -0
  27. data/doc/index.html +0 -100
  28. data/doc/js/app.js +0 -243
  29. data/doc/js/full_list.js +0 -216
  30. data/doc/js/jquery.js +0 -4
  31. data/doc/just_file_list.html +0 -40
  32. data/doc/method_list.html +0 -843
  33. data/doc/top-level-namespace.html +0 -118
  34. data/home_my_yard/templates/visualruby/class/dot/superklass.erb +0 -3
  35. data/home_my_yard/templates/visualruby/class/html/constructor_details.erb +0 -8
  36. data/home_my_yard/templates/visualruby/class/html/subclasses.erb +0 -4
  37. data/home_my_yard/templates/visualruby/class/text/subclasses.erb +0 -5
  38. data/home_my_yard/templates/visualruby/constant/text/header.erb +0 -11
  39. data/home_my_yard/templates/visualruby/docstring/html/abstract.erb +0 -4
  40. data/home_my_yard/templates/visualruby/docstring/html/deprecated.erb +0 -1
  41. data/home_my_yard/templates/visualruby/docstring/html/index.erb +0 -5
  42. data/home_my_yard/templates/visualruby/docstring/html/note.erb +0 -6
  43. data/home_my_yard/templates/visualruby/docstring/html/private.erb +0 -4
  44. data/home_my_yard/templates/visualruby/docstring/html/returns_void.erb +0 -1
  45. data/home_my_yard/templates/visualruby/docstring/html/text.erb +0 -1
  46. data/home_my_yard/templates/visualruby/docstring/html/todo.erb +0 -6
  47. data/home_my_yard/templates/visualruby/docstring/text/abstract.erb +0 -2
  48. data/home_my_yard/templates/visualruby/docstring/text/deprecated.erb +0 -2
  49. data/home_my_yard/templates/visualruby/docstring/text/index.erb +0 -2
  50. data/home_my_yard/templates/visualruby/docstring/text/note.erb +0 -4
  51. data/home_my_yard/templates/visualruby/docstring/text/private.erb +0 -2
  52. data/home_my_yard/templates/visualruby/docstring/text/returns_void.erb +0 -1
  53. data/home_my_yard/templates/visualruby/docstring/text/text.erb +0 -1
  54. data/home_my_yard/templates/visualruby/docstring/text/todo.erb +0 -4
  55. data/home_my_yard/templates/visualruby/fulldoc/html/class_and_method.erb +0 -42
  56. data/home_my_yard/templates/visualruby/fulldoc/html/css/common.css +0 -1
  57. data/home_my_yard/templates/visualruby/fulldoc/html/css/full_list.css +0 -62
  58. data/home_my_yard/templates/visualruby/fulldoc/html/css/style.css +0 -476
  59. data/home_my_yard/templates/visualruby/fulldoc/html/frames.erb +0 -17
  60. data/home_my_yard/templates/visualruby/fulldoc/html/full_list.erb +0 -37
  61. data/home_my_yard/templates/visualruby/fulldoc/html/full_list_class.erb +0 -2
  62. data/home_my_yard/templates/visualruby/fulldoc/html/full_list_file.erb +0 -7
  63. data/home_my_yard/templates/visualruby/fulldoc/html/full_list_method.erb +0 -10
  64. data/home_my_yard/templates/visualruby/fulldoc/html/js/app.js +0 -243
  65. data/home_my_yard/templates/visualruby/fulldoc/html/js/full_list.js +0 -213
  66. data/home_my_yard/templates/visualruby/fulldoc/html/js/jquery.js +0 -4
  67. data/home_my_yard/templates/visualruby/fulldoc/html/just_files.erb +0 -33
  68. data/home_my_yard/templates/visualruby/layout/dot/header.erb +0 -6
  69. data/home_my_yard/templates/visualruby/layout/html/breadcrumb.erb +0 -11
  70. data/home_my_yard/templates/visualruby/layout/html/files.erb +0 -11
  71. data/home_my_yard/templates/visualruby/layout/html/footer.erb +0 -5
  72. data/home_my_yard/templates/visualruby/layout/html/headers.erb +0 -15
  73. data/home_my_yard/templates/visualruby/layout/html/index.erb +0 -2
  74. data/home_my_yard/templates/visualruby/layout/html/layout.erb +0 -30
  75. data/home_my_yard/templates/visualruby/layout/html/listing.erb +0 -4
  76. data/home_my_yard/templates/visualruby/layout/html/objects.erb +0 -32
  77. data/home_my_yard/templates/visualruby/layout/html/script_setup.erb +0 -4
  78. data/home_my_yard/templates/visualruby/layout/html/search.erb +0 -13
  79. data/home_my_yard/templates/visualruby/method/html/header.erb +0 -17
  80. data/home_my_yard/templates/visualruby/method/text/header.erb +0 -1
  81. data/home_my_yard/templates/visualruby/method_details/html/header.erb +0 -3
  82. data/home_my_yard/templates/visualruby/method_details/html/method_signature.erb +0 -25
  83. data/home_my_yard/templates/visualruby/method_details/html/source.erb +0 -10
  84. data/home_my_yard/templates/visualruby/method_details/text/header.erb +0 -10
  85. data/home_my_yard/templates/visualruby/method_details/text/method_signature.erb +0 -12
  86. data/home_my_yard/templates/visualruby/module/dot/child.erb +0 -1
  87. data/home_my_yard/templates/visualruby/module/dot/dependencies.erb +0 -3
  88. data/home_my_yard/templates/visualruby/module/dot/header.erb +0 -6
  89. data/home_my_yard/templates/visualruby/module/dot/info.erb +0 -14
  90. data/home_my_yard/templates/visualruby/module/html/attribute_details.erb +0 -10
  91. data/home_my_yard/templates/visualruby/module/html/attribute_summary.erb +0 -8
  92. data/home_my_yard/templates/visualruby/module/html/box_info.erb +0 -43
  93. data/home_my_yard/templates/visualruby/module/html/children.erb +0 -8
  94. data/home_my_yard/templates/visualruby/module/html/constant_summary.erb +0 -13
  95. data/home_my_yard/templates/visualruby/module/html/defines.erb +0 -3
  96. data/home_my_yard/templates/visualruby/module/html/header.erb +0 -5
  97. data/home_my_yard/templates/visualruby/module/html/inherited_attributes.erb +0 -14
  98. data/home_my_yard/templates/visualruby/module/html/inherited_constants.erb +0 -8
  99. data/home_my_yard/templates/visualruby/module/html/inherited_methods.erb +0 -19
  100. data/home_my_yard/templates/visualruby/module/html/item_summary.erb +0 -40
  101. data/home_my_yard/templates/visualruby/module/html/method_details_list.erb +0 -9
  102. data/home_my_yard/templates/visualruby/module/html/method_summary.erb +0 -14
  103. data/home_my_yard/templates/visualruby/module/html/methodmissing.erb +0 -12
  104. data/home_my_yard/templates/visualruby/module/html/pre_docstring.erb +0 -1
  105. data/home_my_yard/templates/visualruby/module/text/children.erb +0 -10
  106. data/home_my_yard/templates/visualruby/module/text/class_meths_list.erb +0 -8
  107. data/home_my_yard/templates/visualruby/module/text/extends.erb +0 -8
  108. data/home_my_yard/templates/visualruby/module/text/header.erb +0 -7
  109. data/home_my_yard/templates/visualruby/module/text/includes.erb +0 -8
  110. data/home_my_yard/templates/visualruby/module/text/instance_meths_list.erb +0 -8
  111. data/home_my_yard/templates/visualruby/onefile/html/files.erb +0 -5
  112. data/home_my_yard/templates/visualruby/onefile/html/headers.erb +0 -6
  113. data/home_my_yard/templates/visualruby/onefile/html/layout.erb +0 -17
  114. data/home_my_yard/templates/visualruby/onefile/html/readme.erb +0 -3
  115. data/home_my_yard/templates/visualruby/root/dot/child.erb +0 -3
  116. data/home_my_yard/templates/visualruby/tags/html/example.erb +0 -11
  117. data/home_my_yard/templates/visualruby/tags/html/index.erb +0 -3
  118. data/home_my_yard/templates/visualruby/tags/html/option.erb +0 -24
  119. data/home_my_yard/templates/visualruby/tags/html/overload.erb +0 -14
  120. data/home_my_yard/templates/visualruby/tags/html/see.erb +0 -8
  121. data/home_my_yard/templates/visualruby/tags/html/tag.erb +0 -20
  122. data/home_my_yard/templates/visualruby/tags/text/example.erb +0 -12
  123. data/home_my_yard/templates/visualruby/tags/text/index.erb +0 -1
  124. data/home_my_yard/templates/visualruby/tags/text/option.erb +0 -20
  125. data/home_my_yard/templates/visualruby/tags/text/overload.erb +0 -19
  126. data/home_my_yard/templates/visualruby/tags/text/see.erb +0 -11
  127. data/home_my_yard/templates/visualruby/tags/text/tag.erb +0 -13
  128. data/home_my_yard/themes/visualruby.yaml +0 -36
  129. data/my_yard.gemspec +0 -20
  130. data/notes +0 -9
  131. data/src/GlobalSettings.rb +0 -22
  132. data/src/glade/MyYard.glade~ +0 -611
  133. data/src/glade/YardTheme.glade~ +0 -1062
  134. /data/{src → lib}/YardThemeDefaults.rb +0 -0
@@ -1,43 +0,0 @@
1
- <div class="box_info">
2
- <% if CodeObjects::ClassObject === object && object.superclass %>
3
- <dl>
4
- <dt>Inherits:</dt>
5
- <dd>
6
- <span class="inheritName"><%= linkify object.superclass %></span>
7
- <% if object.superclass.name != :BasicObject %>
8
- <ul class="fullTree">
9
- <li><%= linkify P(:Object) %></li>
10
- <% object.inheritance_tree.reverse.each_with_index do |obj, i| %>
11
- <li class="next"><%= obj == object ? obj.path : linkify(obj) %></li>
12
- <% end %>
13
- </ul>
14
- <a href="#" class="inheritanceTree">show all</a>
15
- <% end %>
16
- </dd>
17
- </dl>
18
- <% end %>
19
-
20
- <% [[:class, "Extended by"], [:instance, "Includes"]].each do |scope, name| %>
21
- <% if (mix = run_verifier(object.mixins(scope))).size > 0 %>
22
- <dl>
23
- <dt><%= name %>:</dt>
24
- <dd><%= mix.sort_by {|o| o.path }.map {|o| linkify(o) }.join(", ") %></dd>
25
- </dl>
26
- <% end %>
27
- <% end %>
28
-
29
- <% if (mixed_into = mixed_into(object)).size > 0 %>
30
- <dl>
31
- <dt>Included in:</dt>
32
- <dd><%= mixed_into.sort_by {|o| o.path }.map {|o| linkify(o) }.join(", ") %></dd>
33
- </dl>
34
- <% end %>
35
-
36
- <% unless object.root? %>
37
- <dl>
38
- <dt>Defined in:</dt>
39
- <dd><%= erb(:defines) %></dd>
40
- </dl>
41
- <% end %>
42
- </div>
43
-
@@ -1,8 +0,0 @@
1
- <h2>Defined Under Namespace</h2>
2
- <p class="children">
3
- <% @inner.each do |name, list| %>
4
- <% if list.size > 0 %>
5
- <strong class="<%= name %>"><%= name.to_s.capitalize %>:</strong> <%= list.map {|child| linkify(child, child.name(true)) }.join(", ") %>
6
- <% end %>
7
- <% end %>
8
- </p>
@@ -1,13 +0,0 @@
1
- <% if constant_listing.size > 0 || object.constants.size > 0 %>
2
- <h2>Constant Summary</h2>
3
- <% if constant_listing.size > 0 %>
4
- <dl class="constants">
5
- <% constant_listing.each do |cnst| %>
6
- <dt id="<%= anchor_for(cnst) %>" class="<%= cnst.has_tag?(:deprecated) ? 'deprecated' : '' %>"><%= cnst.name %> =
7
- <%= yieldall :object => cnst %>
8
- </dt>
9
- <dd><pre class="code"><%= format_constant cnst.value %></pre></dd>
10
- <% end %>
11
- </dl>
12
- <% end %>
13
- <% end %>
@@ -1,3 +0,0 @@
1
- <%= object.file ? object.file : '(unknown)' %><% if object.files.size > 1 %><span class="defines">,<br />
2
- <%= object.files[1..-1].map {|f| f.first }.join(",<br /> ") %></span>
3
- <% end %>
@@ -1,5 +0,0 @@
1
- <h1><%= format_object_title(object) %>
2
- <% if object.has_tag?(:abstract) %><span class="abstract note title">Abstract</span><% end %>
3
- <% if object.has_tag?(:deprecated) %><span class="deprecated note title">Deprecated</span><% end %>
4
- <% if object.has_tag?(:api) && object.tag(:api).text == 'private' %><span class="private note title">Private</span><% end %>
5
- </h1>
@@ -1,14 +0,0 @@
1
- <% found_method = false %>
2
- <% inherited_attr_list do |superclass, attribs| %>
3
- <% if attr_listing.size == 0 && !found_method %><h2>Instance Attribute Summary</h2><% end %>
4
- <% found_method = true %>
5
- <h3 class="inherited">Attributes <%= superclass.type == :class ? 'inherited' : 'included' %> from <%= linkify superclass %></h3>
6
- <p class="inherited"><%= attribs.map do |method|
7
- name = method.name(true).gsub(/=$/, '')
8
- if superclass.type == :module && object.instance_mixins.include?(superclass)
9
- name = "##{name}" unless name =~ /^#/
10
- end
11
- linkify(method, name)
12
- end.join(", ")
13
- %></p>
14
- <% end %>
@@ -1,8 +0,0 @@
1
- <% found_const = false %>
2
- <% inherited_constant_list do |superclass, consts| %>
3
- <% if constant_listing.size == 0 && !found_const %><h2>Constant Summary</h2><% end %>
4
- <% found_const = true %>
5
- <h3 class="inherited">Constants <%= superclass.type == :class ? 'inherited' : 'included' %>
6
- from <%= linkify superclass %></h3>
7
- <p class="inherited"><%= consts.map {|c| linkify c }.join(", ") %></p>
8
- <% end %>
@@ -1,19 +0,0 @@
1
- <% found_method = false %>
2
- <% object.inheritance_tree(true)[1..-1].each do |superclass| %>
3
- <% next if superclass.is_a?(YARD::CodeObjects::Proxy) %>
4
- <% next if options.embed_mixins.size > 0 && options.embed_mixins_match?(superclass) != false %>
5
- <% meths = prune_method_listing(superclass.meths(:included => false, :inherited => false)) %>
6
- <% meths.reject! {|m| object.child(:scope => m.scope, :name => m.name) != nil } %>
7
- <% meths.reject! {|m| m.is_alias? || m.is_attribute? } %>
8
- <% next if meths.size == 0 %>
9
- <% if method_listing.size == 0 && !found_method %><h2>Method Summary</h2><% end %>
10
- <% found_method = true %>
11
- <h3 class="inherited">Methods <%= superclass.type == :class ? 'inherited' : 'included' %> from <%= linkify superclass %></h3>
12
- <p class="inherited"><%=
13
- meths.sort_by {|o| o.name.to_s }.map do |m|
14
- name = m.name(true)
15
- name = name.gsub(/^#/,'') if superclass.type == :module && object.class_mixins.include?(superclass)
16
- linkify(m, name)
17
- end.join(", ")
18
- %></p>
19
- <% end %>
@@ -1,40 +0,0 @@
1
- <li class="<%= @item.visibility %> <%= @item.has_tag?(:deprecated) ? 'deprecated' : '' %>">
2
- <span class="summary_signature">
3
- <% if @item.tags(:overload).size == 1 %>
4
- <%= signature(@item.tag(:overload), true, !@item.attr_info) %>
5
- <% else %>
6
- <%= signature(@item, true, false, !@item.attr_info) %>
7
- <% end %>
8
-
9
- <% if @item.aliases.size > 0 %>
10
- (also: <%= @item.aliases.map {|o| h(o.name(true)) }.join(", ") %>)
11
- <% end %>
12
- </span>
13
- <% if object != @item.namespace %>
14
- <span class="note title not_defined_here">
15
- <%= @item.namespace.type == :class ? 'inherited' : (@item.scope == :class ? 'extended' : 'included') %>
16
- from <%= linkify @item, object.relative_path(@item.namespace) %>
17
- </span>
18
- <% end %>
19
- <% if @item.constructor? %>
20
- <span class="note title constructor">constructor</span>
21
- <% end %>
22
- <% if rw = @item.attr_info %>
23
- <% if !run_verifier([rw[:read]].compact).empty? && run_verifier([rw[:write]].compact).empty? %>
24
- <span class="note title readonly">readonly</span>
25
- <% end %>
26
- <% if !run_verifier([rw[:write]].compact).empty? && run_verifier([rw[:read]].compact).empty? %>
27
- <span class="note title writeonly">writeonly</span>
28
- <% end %>
29
- <% end %>
30
- <% if @item.visibility != :public %><span class="note title <%= @item.visibility %>"><%= @item.visibility %></span><% end %>
31
- <% if @item.has_tag?(:abstract) %><span class="abstract note title">abstract</span><% end %>
32
- <% if @item.has_tag?(:deprecated) %><span class="deprecated note title">deprecated</span><% end %>
33
- <% if @item.has_tag?(:api) && @item.tag(:api).text == 'private' %><span class="private note title">private</span><% end %>
34
-
35
- <% if @item.has_tag?(:deprecated) %>
36
- <span class="summary_desc"><strong>Deprecated.</strong> <%= htmlify_line @item.tag(:deprecated).text %></span>
37
- <% else %>
38
- <span class="summary_desc"><%= htmlify_line docstring_summary(@item) %></span>
39
- <% end %>
40
- </li>
@@ -1,9 +0,0 @@
1
- <% scopes(method_listing(false)) do |list, scope| %>
2
- <div id="<%= scope %>_method_details" class="method_details_list">
3
- <h2><%= scope.to_s.capitalize %> Method Details</h2>
4
-
5
- <% list.each_with_index do |meth, i| %>
6
- <%= yieldall :object => meth, :owner => object, :index => i %>
7
- <% end %>
8
- </div>
9
- <% end %>
@@ -1,14 +0,0 @@
1
- <% if method_listing.size > 0 %>
2
- <% groups(method_listing) do |list, name| %>
3
- <h2>
4
- <%= name %>
5
- <small><a href="#" class="summary_toggle">collapse</a></small>
6
- </h2>
7
-
8
- <ul class="summary">
9
- <% list.each do |meth| %>
10
- <%= yieldall :item => meth %>
11
- <% end %>
12
- </ul>
13
- <% end %>
14
- <% end %>
@@ -1,12 +0,0 @@
1
- <div id="method_missing_details" class="method_details_list">
2
- <h2>Dynamic Method Handling</h2>
3
- <p class="notice <%= @mm.namespace == object ? 'this' : 'super' %>">
4
- This class handles dynamic methods through the <tt>method_missing</tt> method
5
- <% if @mm.namespace != object %>
6
- in the class <%= linkify @mm, @mm.namespace.path %>
7
- <% end %>
8
- </p>
9
- <% if @mm.namespace == object %>
10
- <%= yieldall :object => @mm, :index => 0 %>
11
- <% end %>
12
- </div>
@@ -1 +0,0 @@
1
- <h2>Overview</h2>
@@ -1,10 +0,0 @@
1
- Defined Under Namespace:
2
- ------------------------
3
-
4
- <% @inner.each do |name, list| %>
5
- <% if list.size > 0 %>
6
- <% text = list.map {|c| c.name }.join(", ") + " (#{name})" %>
7
- <%= indent(wrap(text)) %>
8
-
9
- <% end %>
10
- <% end %>
@@ -1,8 +0,0 @@
1
- <% if class_meths.size > 0 %>
2
- Class methods:
3
- --------------
4
-
5
- <%= indent wrap(class_meths.map {|o| o.name.to_s }.join(", "), 68) %>
6
-
7
-
8
- <% end %>
@@ -1,8 +0,0 @@
1
- <% if object.mixins(:class).size > 0 %>
2
- Extended by:
3
- ------------
4
-
5
- <%= indent wrap(object.mixins(:class).join(", "), 68) %>
6
-
7
-
8
- <% end %>
@@ -1,7 +0,0 @@
1
- <%= title_align_right format_object_title(object) %>
2
-
3
- <%= yieldall %>
4
-
5
- <%= hr %>
6
-
7
-
@@ -1,8 +0,0 @@
1
- <% if object.mixins(:instance).size > 0 %>
2
- Includes:
3
- ---------
4
-
5
- <%= indent wrap(object.mixins(:instance).join(", "), 68) %>
6
-
7
-
8
- <% end %>
@@ -1,8 +0,0 @@
1
- <% if instance_meths.size > 0 %>
2
- Instance methods:
3
- -----------------
4
-
5
- <%= indent wrap(instance_meths.map {|o| o.name.to_s }.join(", "), 68) %>
6
-
7
-
8
- <% end %>
@@ -1,5 +0,0 @@
1
- <% @files.each do |file| %>
2
- <% @file = file %>
3
- <h2><%= file.title %></h2>
4
- <%= diskfile %>
5
- <% end %>
@@ -1,6 +0,0 @@
1
- <style type="text/css">
2
- <%= @css_data %>
3
- </style>
4
- <script type="text/javascript" charset="utf-8">
5
- <%= @js_data %>
6
- </script>
@@ -1,17 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
- <head>
5
- <meta http-equiv="Content-Type" content="text/html; charset=<%= charset %>" />
6
- <title><%= @title %></title>
7
- <%= erb(:headers) %>
8
- </head>
9
- <body>
10
- <div id="content">
11
- <h1><%= @title %></h1>
12
- <%= yieldall %>
13
- </div>
14
-
15
- <%= erb(:footer) %>
16
- </body>
17
- </html>
@@ -1,3 +0,0 @@
1
- <div id="readme">
2
- <%= htmlify(parse_top_comments_from_file) %>
3
- </div>
@@ -1,3 +0,0 @@
1
- <% if inner = yieldall.gsub("\n", '') %>
2
- Root [label="{<%= inner %>}" rank=sink];
3
- <% end %>
@@ -1,11 +0,0 @@
1
- <% if object.has_tag?(:example) %>
2
- <div class="examples">
3
- <p class="tag_title">Examples:</p>
4
- <% object.tags(:example).each do |tag| %>
5
- <% unless tag.name.empty? %>
6
- <p class="example_title"><%= htmlify_line(tag.name) %></p>
7
- <% end %>
8
- <pre class="example code"><code><%= html_syntax_highlight(tag.text) %></code></pre>
9
- <% end %>
10
- </div>
11
- <% end %>
@@ -1,3 +0,0 @@
1
- <div class="tags">
2
- <%= yieldall %>
3
- </div>
@@ -1,24 +0,0 @@
1
- <% if object.has_tag?(:option) %>
2
- <% object.parameters.each do |param, default| %>
3
- <% tags = object.tags(:option).select {|x| x.name.to_s == param.to_s.sub(/^\*+/, '') } %>
4
- <% next if tags.empty? %>
5
- <p class="tag_title">Options Hash (<tt><%= param %></tt>):</p>
6
- <ul class="option">
7
- <% for tag in tags %>
8
- <li>
9
- <span class="name"><%= tag.pair.name %></span>
10
- <span class="type"><%= format_types(tag.pair.types || ['Object']) %></span>
11
- <span class="default">
12
- <% if tag.pair.defaults %>
13
- &mdash; default:
14
- <%= tag.pair.defaults.map {|t| "<tt>#{h t}</tt>" }.join(", ") %>
15
- <% end %>
16
- </span>
17
- <% if tag.pair.text && tag.pair.text =~ /\S/ %>
18
- &mdash; <%= htmlify_line(tag.pair.text) %>
19
- <% end %>
20
- </li>
21
- <% end %>
22
- </ul>
23
- <% end %>
24
- <% end %>
@@ -1,14 +0,0 @@
1
- <% if object.tags(:overload).size == 1 %>
2
- <%= yieldall :object => object.tag(:overload) %>
3
- <% elsif object.has_tag?(:overload) && object.tags(:overload).any? {|o| !o.docstring.blank? } %>
4
- <p class="tag_title">Overloads:</p>
5
- <ul class="overload">
6
- <% object.tags(:overload).each do |overload| %>
7
- <% next if overload.docstring.blank? %>
8
- <li class="overload_item">
9
- <span class="signature"><%= signature(overload, false, false) %></span>
10
- <%= yieldall :object => overload %>
11
- </li>
12
- <% end %>
13
- </ul>
14
- <% end %>
@@ -1,8 +0,0 @@
1
- <% if object.has_tag?(:see) %>
2
- <p class="tag_title">See Also:</p>
3
- <ul class="see">
4
- <% for tag in object.tags(:see) %>
5
- <li><%= linkify(tag.name, tag.text) %></li>
6
- <% end %>
7
- </ul>
8
- <% end %>
@@ -1,20 +0,0 @@
1
- <p class="tag_title"><%= @label ? @label : YARD::Tags::Library.labels[@name] %>:</p>
2
- <ul class="<%= @name %>">
3
- <% object.tags(@name).each do |tag| %>
4
- <li>
5
- <% unless @no_names %>
6
- <span class='name'><%= h tag.name %></span>
7
- <% end %>
8
- <% unless @no_types %>
9
- <span class='type'><%= format_types(tag.types) %></span>
10
- <% end %>
11
- <% if @name == :param && (o=object.parameters.assoc(tag.name.to_s)) && o[1] %>
12
- <em class="default">(defaults to: <tt><%= h o[1] %></tt>)</em>
13
- <% end %>
14
- <% if tag.text && !tag.text.empty? %>
15
- <% unless (@no_types || tag.types.nil? || tag.types.empty?) && @no_names %>&mdash;<% end %>
16
- <%= htmlify_line(tag.text) %>
17
- <% end %>
18
- </li>
19
- <% end %>
20
- </ul>
@@ -1,12 +0,0 @@
1
- <% if object.has_tag?(:example) %>
2
-
3
- Examples:
4
- ---------
5
-
6
- <% object.tags(:example).each_with_index do |tag, i| %>
7
- <%= indent("# " + tag.name + "\n") if tag.name %>
8
- <%= indent(format_source(tag.text)) + "\n" %>
9
- <%= "\n" if i < object.tags(:example).size - 1 %>
10
- <% end %>
11
- <% end %>
12
-
@@ -1 +0,0 @@
1
- <%= yieldall %>
@@ -1,20 +0,0 @@
1
- <% if object.has_tag?(:option) %>
2
- <% object.parameters.each do |param, default| %>
3
- <% tags = object.tags(:option).select {|x| x.name.to_s == param.to_s } %>
4
- <% next if tags.empty? %>
5
- Options Hash (<%= param %>):
6
- --------------<%= hr(param.to_s.length) %>--
7
-
8
- <% for tag in tags %>
9
- <% text = "" %>
10
- <% text += format_types(tag.pair.types || ['Object']) %>
11
- <% text += " " + tag.pair.name.to_s %>
12
- <% if tag.pair.defaults %>
13
- <% text += " - default: " + tag.pair.defaults.join(", ") %>
14
- <% end %>
15
- <% text += " - " + tag.pair.text if tag.pair.text %>
16
- <%= indent(wrap(text)) %>
17
-
18
- <% end %>
19
- <% end %>
20
- <% end %>
@@ -1,19 +0,0 @@
1
- <% if object.tags(:overload).size == 1 %>
2
- <%= wrap(yieldall(:object => object.tag(:overload))) %>
3
- <% elsif object.has_tag?(:overload) %>
4
- Overloads:
5
- ----------
6
-
7
- <% object.tags(:overload).each do |overload| %>
8
- <% if overload.tags.size > 0 %>
9
- <%= hr %>
10
-
11
- <%= indent signature(overload) %>
12
-
13
- <%= hr %>
14
-
15
- <%= indent(wrap(yieldall(:object => overload))) %>
16
-
17
- <% end %>
18
- <% end %>
19
- <% end %>
@@ -1,11 +0,0 @@
1
- <% if object.has_tag?(:see) %>
2
- See Also:
3
- ---------
4
-
5
- <% for tag in object.tags(:see) %>
6
- <% text = "- " + tag.name %>
7
- <% text += " - " + tag.text if tag.text && !tag.text.empty? %>
8
- <%= indent(wrap(text)) %>
9
- <% end %>
10
- <% end %>
11
-
@@ -1,13 +0,0 @@
1
- <% title = @label ? @label : YARD::Tags::Library.labels[@name] %>
2
- <%= title %>:
3
- <%= hr(title.length) %>-
4
-
5
- <% object.tags(@name).each do |tag| %>
6
- <% text = "" %>
7
- <% text += format_types(tag.types) + " " unless @no_types || tag.types.nil? %>
8
- <% text += tag.name.to_s + " " unless @no_names %>
9
- <% text += "- " unless @no_names && @no_types %>
10
- <% text += tag.text if tag.text && !tag.text.empty? %>
11
- <%= indent wrap(text) %>
12
-
13
- <% end %>
@@ -1,36 +0,0 @@
1
- --- !ruby/object:YardTheme
2
- css:
3
- body {color}: "#000000"
4
- "#main {background}": "#ffffff"
5
- body {background-color}: "#ffffff"
6
- body {font-size}: 15px
7
- p {width}: 65%
8
- "#main a, #main a:visited {color}": "#662211"
9
- ".object_link a {color}": "#662211"
10
- li.odd {background}: "#eeeeee"
11
- li.even {background}: "#dddddd"
12
- ".item:hover {background}": "#d7d5c1"
13
- li.clicked > .item {background}: "#000000"
14
- li.clicked > .item {color}: "#d3d7cf"
15
- "#main a:hover {background}": "#f6f5cb"
16
- h1 {font-family}: Assistant
17
- h2 {font-family}: Raleway
18
- h3 {font-family}: Rubik One
19
- h1 {font-weight}: '200'
20
- h2 {font-weight}: '300'
21
- h3 {font-weight}: '300'
22
- h1 {font-size}: 3em
23
- h2 {font-size}: 1.4em
24
- h3 {font-size}: 1.4em
25
- h1 {color}: "#662211"
26
- h2 {color}: "#000000"
27
- h3 {color}: "#000000"
28
- h1 {background}: "#ffffff"
29
- h2 {background}: "#ffffff"
30
- h3 {background}: "#ebeade"
31
- "#toc {background-color}": "#f3f3eb"
32
- p.signature, h3.signature {background}: "#0a6"
33
- "#main p {width}": 65%
34
- vr_yaml_file: "/home/eric/my_yard/themes/visualruby.yaml"
35
- builder: !ruby/object:Gtk::Builder {}
36
- top_level_window: false
data/my_yard.gemspec DELETED
@@ -1,20 +0,0 @@
1
- Gem::Specification.new do |s|
2
- s.name = "my_yard" # i.e. visualruby. This name will show up in the gem list.
3
- s.version = "0.0.2" # i.e. (major,non-backwards compatable).(backwards compatable).(bugfix)
4
- s.add_dependency "visualruby", ">= 3.0.20"
5
- s.add_dependency "yard", "= 0.9.0"
6
- s.has_rdoc = false
7
- s.authors = ["Eric Cunningham"]
8
- s.email = "beagle4321_2000@yahoo.com" # optional
9
- s.summary = "Great GUI for generating docs with Yard." # optional
10
- s.homepage = "http://visualruby.net/" # optional
11
- s.description = "This program offers a great way to generate docs with yard. " +
12
- "It has a GUI so you don't need to use all the command line parameters. " +
13
- "To see an example of the output, visit http://visualruby.net"
14
- s.executables = ['my_yard'] # i.e. 'vr' (optional, blank if library project)
15
- s.default_executable = 'my_yard' # i.e. 'vr' (optional, blank if library project)
16
- s.bindir = ['.'] # optional, default = bin
17
- # s.require_paths = ['lib'] # optional, default = lib
18
- s.files = Dir.glob("**/*")
19
- s.rubyforge_project = "nowarning" # supress warning message
20
- end
data/notes DELETED
@@ -1,9 +0,0 @@
1
- To make yard compatible:
2
-
3
- #search { position: static;}
4
- .fixed_header { position: static; padding-bottom: 0px;}
5
- #full_list {margin-top: 15px; }
6
-
7
- remove height: 70px from .fixed_header class in full_list.css
8
-
9
-
@@ -1,22 +0,0 @@
1
-
2
- class GlobalSettings
3
-
4
- include GladeGUI
5
-
6
- attr_accessor :browser, :projects, :theme_root, :template_root
7
-
8
- def defaults
9
- @browser ||= "firefox"
10
- @projects ||= []
11
- @theme_root = File.join(Dir.home, "my_yard", "themes")
12
- @template_root = File.join(Dir.home, "my_yard", "templates")
13
- end
14
-
15
- def add_project(proj_path)
16
- unless @projects.include?(proj_path)
17
- @projects << proj_path
18
- VR::save_yaml(self)
19
- end
20
- end
21
-
22
- end