yard 0.2.3.5 → 0.4.0

data/templates/default/methodsummary/html/summary.erb

@@ -1,29 +0,0 @@
-<h1><%= visibility.to_s.capitalize %> <%= scope.to_s.capitalize %> Method Summary</h1>
-<table class="summary">
-  <% method_list.each do |meth| %>
-    <tr>
-      <th class="signature">
-        <% overloads(meth).each do |overload| %>
-          <span class='overload'>
-            <span class='name'><%= linkify(meth, overload.name(true)) %></span><span class='args'><%= format_args overload %></span>
-            <span class='block'><%= format_block overload %></span>
-          </span>
-        <% end %>
-        <% meth.aliases.each do |obj| %>
-          <span class='alias'><%= h obj.name(true) %></span>
-        <% end %>
-      </th>
-      <td class="docstring">
-        <%= htmlify meth.docstring.summary %>
-        <% if meth.tag(:return) && meth.tag(:return).types %>
-          <p class='returns'>
-            Returns: 
-              <span class='return_types'>
-                 <%= format_return_types meth %>
-              </span>
-          </p>
-        <% end %>
-      </td>
-    </tr>
-  <% end %>
-</table>

data/templates/default/methodsummary/text/header.erb

@@ -1,5 +0,0 @@
-
-
-> <%= visibility.to_s.capitalize %> Method List
-<%= '-' * visibility.to_s.length %>--------------
-<%= yield object %>

data/templates/default/methodsummary/text/summary.erb

@@ -1,6 +0,0 @@
-<% method_list.sort_by {|m| "#{m.scope}#{m.name}" }.each do |meth| %>
-<% overloads(meth).each do |overload| %>
-<%= overload.visibility == :class ? '+' : '-' %> <%= overload.name(true) %><%= format_args overload %> <%= format_block overload %>
-
-<% end %>
-<% end %>

data/templates/default/mixins/html/header.erb

@@ -1,4 +0,0 @@
-<div class="section <%= generator_name %>">
-  <h1><%= scope == :instance ? "Included" : "Extended" %> Modules</h1>
-  <p><%= object.mixins(scope).map {|o| linkify o }.join(", ") %></p>
-</div>

data/templates/default/overloads/html/header.erb

@@ -1,8 +0,0 @@
-<div class="section <%= generator_name %>">
-  <h2>Overloads</h2>
-  <% overloads(object).each do |overload| %>
-    <div class="overload">
-      <%= yield overload %>
-    </div>
-  <% end %>
-</div>

data/templates/default/overloads/text/header.erb

@@ -1,8 +0,0 @@
-Overloads
-=========
-
-<% overloads(object).each do |overload| %>
-<%= yield(overload).gsub(/^/, '  ') %>
-
-
-<% end %>

data/templates/default/quickdoc/html/header.erb

@@ -1,15 +0,0 @@
-<h1>Documentation for <%= h object.path %></h1>
-
-<dl class="general_info">
-<% if object.file %>
-  <dt>File:</dt>
-  <dd><%= h object.file %></dd>
-<% end %>
-  <dt>Type:</dt>
-  <dd>
-    <%= h(object.tag(:return) && object.tag(:return).type ? object.tag(:return).type : "undefined") %>
-  </dd>
-  <dt>Visibility:</dt>
-  <dd><%= object.visibility %></dd>
-</dl>
-

data/templates/default/quickdoc/text/header.erb

@@ -1,12 +0,0 @@
-Documentation for <%= object.path %>
-
-==================<%= "=" * object.path.length %>
-File: '<%= object.file %>'
-Line: <%= object.line %>
-<% if object.is_a?(CodeObjects::MethodObject) %>
-Visi: <%= object.visibility %>
-Scop: <%= object.scope %>
-Type: <%= object.tag(:return) && object.tag(:return).type ? object.tag(:return).type : "undefined" %>
-<% end %>
-
-<%= yield object %>

data/templates/default/root/html/header.erb

@@ -1,4 +0,0 @@
-<div class="section root">
-  <h1 class="title">Top Level Namespace (Global Methods)</h1>
-  <%= yield object %>
-</div>

data/templates/default/source/html/main.erb

@@ -1,15 +0,0 @@
-<div class="section <%= generator_name %>">
-  <span>[<a class="source_link" href="#">View source</a>]</span>
-  <div class="source_code">
-    <table>
-      <tr>
-        <td>
-          <pre class="lines"><%= "\n\n\n" %><%= h format_lines(object) %></pre>
-        </td>
-        <td>
-          <pre class="code"><span class="info file"># File '<%= h object.file %>', line <%= object.line %></span><%= "\n\n" %><%= html_syntax_highlight object.source %></pre>
-        </td>
-      </tr>
-    </table>
-  </div>
-</div>

data/templates/default/source/text/main.erb

@@ -1,4 +0,0 @@
-Definition:
------------
-<%= format_code(object, true) %>
-

data/templates/default/tags/html/header.erb

@@ -1,4 +0,0 @@
-<div class="section <%= generator_name %>">
-  <h2>Meta Tags</h2>
-  <%= yield object %>
-</div>

data/templates/default/tags/html/param.erb

@@ -1,21 +0,0 @@
-<div class="param">
-  <h3><%= YARD::Tags::Library.labels[:param] %>:</h3>
-  <dl>
-  <% for tag in tags_by_param(object) %>
-    <% if tag.is_a?(YARD::Tags::OptionTag) %>
-      <%= render object, 'option', :param => tag.name.to_s %>
-    <% else %>
-      <dt>
-        <span class='type'><%= format_types (tag.types || ['Object']) %></span>
-        <span class='name'><%= h tag.name %></span>
-        <% if (o=object.parameters.assoc(tag.name.to_sym)) && o[1] %>
-          <em class="default">(defaults to: <tt><%= h o[1] %></tt>)</em>
-        <% end %>
-      </dt>
-      <dd>
-        <span class='desc'><%= htmlify tag.text if tag.text %></span>
-      </dd>
-    <% end %>
-  <% end %>
-  </dl>
-</div>

data/templates/default/tags/html/tags.erb

@@ -1,23 +0,0 @@
-<% if object.has_tag?(name) %>
-<div class="<%= name %>">
-  <h3><%= defined?(label) ? label : YARD::Tags::Library.labels[name] %>:</h3>
-  <dl>
-  <% for tag in object.tags(name) %>
-    <dt>
-      <% unless defined?(no_types) %>
-        <span class='type'><%= format_types (tag.types || ['Object']) %></span>
-      <% end %>
-      <% unless defined?(no_names) %>
-        <span class='name'><%= h tag.name %></span>
-      <% end %>
-      <% if name == :param && (o=object.parameters.assoc(tag.name.to_sym)) && o[1] %>
-        <em class="default">(defaults to: <tt><%= h o[1] %></tt>)</em>
-      <% end %>
-    </dt>
-    <dd>
-      <span class='desc'><%= htmlify tag.text %></span>
-    </dd>
-  <% end %>
-  </dl>
-</div>
-<% end %>

data/templates/default/tags/html/todo.erb

@@ -1,8 +0,0 @@
-<div class="todo">
-  <h3><%= YARD::Tags::Library.labels[:todo] %>:</h3>
-  <ul>
-  <% for tag in object.tags(:todo) %>
-    <li><strong><%= tag.name %></strong> <%= tag.text %></li>
-  <% end %>
-  </ul>
-</div>

data/templates/default/tags/text/header.erb

@@ -1,3 +0,0 @@
-<%= yield(object).strip %>
-
-

data/templates/default/tags/text/param.erb

@@ -1,9 +0,0 @@
-> <%= YARD::Tags::Library.labels[:param] %>:
-<% for tag in tags_by_param(object) %>
-<% if tag.is_a?(YARD::Tags::OptionTag) %>
-<%= render object, 'option', :param => tag.name.to_s %>
-<% else %>
-  - <%= format_types (tag.types || ['Object']) %> <%= h tag.name %> <% if (o=object.parameters.assoc(tag.name.to_sym)) && o[1] %>(defaults to: <%= h o[1] %>)<% end %>
-<%= "    " + tag.text if tag.text %>
-<% end %>
-<% end %>

data/templates/default/tags/text/tags.erb

@@ -1,7 +0,0 @@
-<% if object.has_tag?(name) %>
-> <%= defined?(label) ? label : YARD::Tags::Library.labels[name] %>:
-<% for tag in object.tags(name) %>
-  <%= format_types tag.types unless defined?(no_types) %><%= " " + tag.name.to_s unless defined?(no_names) %>
-    <%= tag.text %>
-<% end %>
-<% end %>

data/templates/default/uml/dot/child.erb

@@ -1 +0,0 @@
-<%= format_path object %> [label="{<%= yield(object).gsub("\n", '') %>}" rank=sink];

data/templates/default/uml/dot/dependencies.erb

@@ -1,10 +0,0 @@
-<% for obj in @objects.select {|o| CodeObjects::NamespaceObject === o } %>
-  <% for depobj in obj.mixins %>
-    <% [obj, depobj].each do |o| %>
-      <% if o != Registry.root && (!o.respond_to?(:children) || !namespaces(o).empty?) %>
-        <%= format_path o %> [label="{<%= o.type %> <%= o.name %>}" rank=sink];
-      <% end %>
-    <% end %>
-    <%= !format_path(obj).empty? ? format_path(obj) : "Kernel" %> -> <%= format_path depobj %> [style=dashed rank=sink];
-  <% end %>
-<% end %>

data/templates/default/uml/dot/superclasses.erb

@@ -1,9 +0,0 @@
-<% for obj in @objects.select {|o| CodeObjects::ClassObject === o && o.superclass && o.superclass != P(:Object) } %>
-  <% [obj, obj.superclass].compact.each do |o| %>
-    <% if o != Registry.root && (!o.respond_to?(:children) || !namespaces(o).empty?) %>
-      <%= format_path o %> [label="{<%= o.type %> <%= o.path %>}" rank=sink];
-    <% end %>
-  <% end %>
-
-  <%= format_path obj %> -> <%= format_path obj.superclass %>;
-<% end %>

data/templates/default/uml/dot/unknown.erb

@@ -1,3 +0,0 @@
-subgraph unknown {
-  <%= yield object %>
-}

data/templates/default/uml/dot/unknown_child.erb

@@ -1 +0,0 @@
-<%= format_path object %> [label="{<%= h object.type %> <%= h object.path %>}" rank=sink];

data/templates/default/visibilitygroup/html/header.erb

@@ -1,6 +0,0 @@
-<% unless (output = yield(object)).empty? %>
-  <div class="section <%= generator_name %> <%= visibility %>">
-    <h1><%= visibility.to_s.capitalize %> Visibility</h1>
-    <%= output %>
-  </div>
-<% end %>

data/templates/javadoc/attributes/html/header.erb

@@ -1,16 +0,0 @@
-<div class="section <%= generator_name %>">
-  <h1>Attributes</h1>
-
-  <% ['class', 'instance'].select {|s| object.attributes[s].length > 0 }.each do |scope| %>
-    <div class="<%= scope %>">
-      <h2><%= scope.capitalize %> Attributes</h2>
-      <tt>
-      <% object.attributes[scope].sort_by {|o| o.to_s.downcase }.each do |name, rw| %>
-        <%= h name %> [<%= ['read', 'write'].map {|t| 
-                rw[t] && !rw[t].is_explicit? ? "<span id='#{anchor_for rw[t]}'>#{t[0,1].upcase}</span>" : t[0,1].upcase
-              }.compact.join %>]<br />
-      <% end %>
-      </tt>
-    </div>
-  <% end %>
-</div>

data/templates/javadoc/class/html/header.erb

@@ -1,4 +0,0 @@
-<div class="section class <%= object.path.gsub(/::|\.|#/, '_') %>">
-  <h1 class="title"><%= h format_object_type(object) %> <%= h object.path %></h1>
-  <%= yield object %>
-</div>

data/templates/javadoc/constants/html/constants.erb

@@ -1,9 +0,0 @@
-<div class="thisclass">
-  <h1>Constants</h1>
-  <dl>
-    <% object.constants(:included => false, :inherited => false).sort_by {|c| c.name.to_s.downcase }.each do |const| %>
-      <dt id="<%= anchor_for(const) %>"><pre><%= h const.source %></pre></dt>
-      <dd><%= htmlify const.docstring %></dd>
-    <% end %>
-  </dl>
-</div>

data/templates/javadoc/constants/html/header.erb

@@ -1,3 +0,0 @@
-<div class="section <%= generator_name %>">
-  <%= yield object %>
-</div>

data/templates/javadoc/constants/html/included.erb

@@ -1,12 +0,0 @@
-<p class="included">
-  <table border="1" width="100%">
-    <% included_constants_by_module do |klass, consts| %>
-    <tr background="#ddddff">
-      <th>Constants included from <%= linkify klass %></th>
-    </tr>
-    <tr>
-      <td><%= format_object_name_list consts %></td>
-    </tr>
-    <% end %>
-  </table>
-</p>

data/templates/javadoc/constants/html/inherited.erb

@@ -1,12 +0,0 @@
-<p class="inherited">
-  <table border="1" width="100%">
-    <% inherited_constants_by_class do |klass, consts| %>
-    <tr background="#ddddff">
-      <th>Constants inherited from <%= linkify klass %></th>
-    </tr>
-    <tr>
-      <td><%= format_object_name_list consts %></td>
-    </tr>
-    <% end %>
-  </table>
-</p>

data/templates/javadoc/constructor/html/header.erb

@@ -1,10 +0,0 @@
-<div class="section <%= generator_name %>">
-  <h1>Constructor Summary</h1>
-  <% if constructor_method_inherited? %>
-    <p class="inherited_msg">
-      <em>This class inherits a constructor from <%= linkify constructor_method, constructor_method.namespace.path %>.</em>
-    </p>
-  <% else %>
-    <%= yield constructor_method %>
-  <% end %>
-</div>

data/templates/javadoc/docstring/html/main.erb

@@ -1,6 +0,0 @@
-<div class="section docstring">
-  <%= htmlify object.docstring %>
-</div>
-<% if object.is_a?(CodeObjects::NamespaceObject) %>
-  <hr />
-<% end %>

data/templates/javadoc/fulldoc/html/all_methods.erb

@@ -1,25 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-<html>
-  <head>
-    <%= render :html_head %>
-    <title>All Modules / Classes</title>
-    <base target="main" />
-  </head>
-  <body>
-    <div id="nav" class="methods">
-      <h1>Method List</h1>
-      <ul>
-      <% for obj in YARD::Registry.all(:method).sort_by {|o| o.path } %>
-        <% next if obj.namespace == Registry.root %>
-        <li nowrap>
-          <%= linkify(obj, (obj.scope == :class ? '' : '#') + obj.name.to_s) %> 
-          <% if obj.namespace != Registry.root %>
-            <em>(<%= obj.namespace.type %> <%= obj.namespace.name %>)</em>
-          <% end %>
-        </li>
-      <% end %>
-      </ul>
-    </div>
-  </body>
-</html>

data/templates/javadoc/fulldoc/html/all_namespaces.erb

@@ -1,19 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-<html>
-  <head>
-    <%= render :html_head %>
-    <title>All Modules / Classes</title>
-    <base target="main" />
-  </head>
-  <body>
-    <div id="nav" class="namespaces">
-      <h1>All Modules / Classes</h1>
-      <ul>
-      <% for obj in YARD::Registry.all(:module, :class).sort_by {|o| o.path } %>
-        <li><%= linkify(obj) %> <em>(<%= obj.type %>)</em></li>
-      <% end %>
-      </ul>
-    </div>
-  </body>
-</html>

data/templates/javadoc/fulldoc/html/app.js

@@ -1,18 +0,0 @@
-$(document).ready(function() {
-    // Set the title of this page as the index title
-    if (parent && parent.document) {
-        $('html head title', parent.document).text($('html head title').text());
-    }
-    
-    // Setup the view source links
-    $(".section.source a.source_link").toggle(
-        function() {
-            $(this).text('Hide source');
-            $(this).parent().next().show();
-        },
-        function() {
-            $(this).text('View source');
-            $(this).parent().next().hide();
-        }
-    );
-});

data/templates/javadoc/fulldoc/html/header.erb

@@ -1,15 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-<html>
-  <head>
-    <%= render :html_head %>
-    <script src="<%= url_for(js_file) %>" type="text/javascript" charset="utf-8"></script>
-    <script src="<%= url_for(js_app_file) %>" type="text/javascript" charset="utf-8"></script>
-    <title><%= h format_object_type(object) %>: <%= h object.path %></title>
-  </head>
-  <body>
-    <div id="content">
-      <%= yield object %>
-    </div>
-  </body>
-</html>

data/templates/javadoc/fulldoc/html/html_head.erb

@@ -1,3 +0,0 @@
-<meta http-equiv="Content-type" content="text/html; charset=utf-8" />
-<link rel="stylesheet" href="<%= url_for(css_file) %>" type="text/css" charset="utf-8" />
-<link rel="stylesheet" href="<%= url_for(css_syntax_file) %>" type="text/css" charset="utf-8" />

data/templates/javadoc/fulldoc/html/index.erb

@@ -1,18 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
-<html>
-  <head>
-    <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
-    <title>YARD Documentation</title>
-  </head>
-  <frameset cols="20%,*">
-    <frameset rows="50%,50%">
-      <frame src="all-namespaces.html" />
-      <frame src="all-methods.html" />
-    </frameset>
-    <frame name="main" src="<%= readme_file ? 'readme.html' : url_for(Registry.all(:module, :class).sort_by {|o| o.path }.first) %>" />
-    <noframes>
-      <p><a href="<%= readme_file ? 'readme.html' : url_for(Registry.all(:module, :class).sort_by {|o| o.path }.first) %>">Click here to go to the title page</a>.</p>
-    </noframes>
-  </frameset>
-</html>