summaryrefslogtreecommitdiffhomepage
path: root/templates
diff options
context:
space:
mode:
authorSeba Gamboa <[email protected]>2015-09-25 10:11:59 -0300
committerSeba Gamboa <[email protected]>2015-09-25 10:11:59 -0300
commit723c2d4bd9575f05b5272a9e2eacb45e1d538af3 (patch)
tree3a1f99ea4ff260eca955c63bf8d76bd7589232e5 /templates
parent5a6d8a0131140873fa1cd37bd3d76b0b06d633ae (diff)
downloadyard-mruby-723c2d4bd9575f05b5272a9e2eacb45e1d538af3.tar.gz
yard-mruby-723c2d4bd9575f05b5272a9e2eacb45e1d538af3.zip
Headers and functions list
Diffstat (limited to 'templates')
-rw-r--r--templates/default/fulldoc/html/full_list_functions.erb10
-rw-r--r--templates/default/fulldoc/html/full_list_headers.erb11
-rw-r--r--templates/default/fulldoc/html/setup.rb7
-rw-r--r--templates/default/header/html/function_summary.erb6
-rw-r--r--templates/default/header/html/setup.rb15
-rw-r--r--templates/default/headersroot/html/headers_list.erb7
-rw-r--r--templates/default/layout/html/setup.rb19
7 files changed, 63 insertions, 12 deletions
diff --git a/templates/default/fulldoc/html/full_list_functions.erb b/templates/default/fulldoc/html/full_list_functions.erb
new file mode 100644
index 0000000..1dca483
--- /dev/null
+++ b/templates/default/fulldoc/html/full_list_functions.erb
@@ -0,0 +1,10 @@
+<% even_odd = 'odd' %>
+<% @items.each do |item| %>
+ <li class="<%= even_odd %> <%= item.has_tag?(:deprecated) ? 'deprecated' : '' %>">
+ <div class="item">
+ <%= linkify item, h(item.name(true)) %>
+ <small><%= item.header.title %></small>
+ </div>
+ </li>
+ <% even_odd = (even_odd == 'even' ? 'odd' : 'even') %>
+<% end %>
diff --git a/templates/default/fulldoc/html/full_list_headers.erb b/templates/default/fulldoc/html/full_list_headers.erb
index 4b32c70..9a1e4e5 100644
--- a/templates/default/fulldoc/html/full_list_headers.erb
+++ b/templates/default/fulldoc/html/full_list_headers.erb
@@ -1 +1,10 @@
-TODO: Display C API
+<li id="object_" class="odd"><div class="item" style="padding-left:30px"><%= link_object(YARD::MRuby::CodeObjects::HEADERS_ROOT, "All Headers", nil, false) %></div></li>
+<% even_odd = 'odd' %>
+<% @items.each do |item| %>
+ <li class="<%= even_odd %>">
+ <div class="item">
+ <%= linkify item, h(item.name(true)) %>
+ </div>
+ </li>
+ <% even_odd = (even_odd == 'even' ? 'odd' : 'even') %>
+<% end %>
diff --git a/templates/default/fulldoc/html/setup.rb b/templates/default/fulldoc/html/setup.rb
index cd2e29a..5e306e8 100644
--- a/templates/default/fulldoc/html/setup.rb
+++ b/templates/default/fulldoc/html/setup.rb
@@ -14,12 +14,17 @@ def init
end
def generate_header_list
- puts "generate_header_list"
headers = Registry.all(:header)
headers_ordered_by_name = headers.sort {|x,y| x.value.to_s <=> y.value.to_s }
generate_full_list headers_ordered_by_name, :headers
end
+def generate_function_list
+ functions = Registry.all(:function)
+ functions_ordered_by_name = functions.sort {|x,y| x.name.to_s <=> y.name.to_s }
+ generate_full_list functions_ordered_by_name, :functions
+end
+
# Helpler method to generate a full_list page of the specified objects with the
# specified type.
def generate_full_list(objects,type,options = {})
diff --git a/templates/default/header/html/function_summary.erb b/templates/default/header/html/function_summary.erb
new file mode 100644
index 0000000..037daa4
--- /dev/null
+++ b/templates/default/header/html/function_summary.erb
@@ -0,0 +1,6 @@
+<ul class="summary">
+
+ <% function_listing.each do |func| %>
+ <%= yieldall :item => func %>
+ <% end %>
+</ul>
diff --git a/templates/default/header/html/setup.rb b/templates/default/header/html/setup.rb
index 757657d..6e5f8f9 100644
--- a/templates/default/header/html/setup.rb
+++ b/templates/default/header/html/setup.rb
@@ -1,10 +1,15 @@
def init
- puts "header!"
- puts object.inspect
super
sections.push :header
- sections.push :functions
-rescue => error
- puts error
+ sections.push :function_summary
end
+
+
+def function_listing
+ return @funcs if @funcs
+
+ @funcs = object.functions
+ @funcs
+end
+
diff --git a/templates/default/headersroot/html/headers_list.erb b/templates/default/headersroot/html/headers_list.erb
index 1b524aa..7b60084 100644
--- a/templates/default/headersroot/html/headers_list.erb
+++ b/templates/default/headersroot/html/headers_list.erb
@@ -1 +1,6 @@
-<h1>All headers</h1>
+<h2>All headers</h2>
+<p class="children">
+ <% headers.each do |header| %>
+ <%= linkify(header, header.name(true)) %>
+ <% end %>
+</p>
diff --git a/templates/default/layout/html/setup.rb b/templates/default/layout/html/setup.rb
index c6e52d2..dc567f2 100644
--- a/templates/default/layout/html/setup.rb
+++ b/templates/default/layout/html/setup.rb
@@ -30,12 +30,23 @@ end
# menus: [ 'features', 'directories', 'tags', 'step definitions', 'steps' ]
#
def menu_lists
+ menus = super
+ last = menus.pop
- [ {
+ menus.push({
type: 'header',
- title: 'C API',
- search_title: 'C API'
- } ] + super
+ title: 'Headers',
+ search_title: 'Header List'
+ })
+ menus.push({
+ type: 'function',
+ title: 'Functions',
+ search_title: 'Function List'
+ })
+
+ menus.push last
+
+ menus
end