aboutsummaryrefslogtreecommitdiff
path: root/src/guff/views/api-docs.ecr
diff options
context:
space:
mode:
Diffstat (limited to 'src/guff/views/api-docs.ecr')
-rw-r--r--src/guff/views/api-docs.ecr72
1 files changed, 48 insertions, 24 deletions
diff --git a/src/guff/views/api-docs.ecr b/src/guff/views/api-docs.ecr
index 8611285..8ab9cc0 100644
--- a/src/guff/views/api-docs.ecr
+++ b/src/guff/views/api-docs.ecr
@@ -1,32 +1,56 @@
<h1><%= TITLE %></h1>
<div class='section'>
-<h2>Table of Contents</h2>
-<ul><% namespaces.each do |namespace| %>
- <li>
- <%= namespace %>
- <ul><% methods(namespace).each do |method| %>
- <li>
- <a
- href='#m-<%= namespace %>-<%= method %>'
- title='View <%= namespace %>/<%= method %> details.'
- >
- <%= method %>
- </a>
- </li>
- <% end %></ul>
- </li>
-<% end %></ul>
+ <h2>Table of Contents</h2>
+ <ul><% namespaces.each do |namespace| %>
+ <li>
+ <a
+ href='#n-<%= namespace %>'
+ title='View <%= namespace %> details.'
+ >
+ <%= namespace %>
+ </a>
+
+ <ul><% methods(namespace).each do |method| %>
+ <li>
+ <a
+ href='#m-<%= namespace %>-<%= method %>'
+ title='View <%= namespace %>/<%= method %> details.'
+ >
+ <%= method %>
+ </a>
+ </li>
+ <% end %></ul>
+ </li>
+ <% end %></ul>
</div><!-- section -->
<% namespaces.each do |namespace| %>
- <% methods(namespace).each do |method| %>
- <div id='m-<%= namespace %>-<%= method %>' class='section'>
- <b><%= namespace %>/<%= method %></b>
+ <div
+ id='n-<%= namespace %>'
+ class='section'
+ >
+ <h2><%= namespace %> methods</h2>
+ <% methods(namespace).each do |method| %>
+ <div
+ id='m-<%= namespace %>-<%= method %>'
+ class='section'
+ >
+ <h3><%= namespace %>/<%= method %></h3>
+
+ <h4>Description</h4>
+ <p>
+ <%= h(method_text(namespace, method)) %>
+ </p>
- <p><%=
- h(APIMethods::API[namespace][method][:text] as String)
- %></p>
- </div><!-- section -->
- <% end %>
+ <h4>Parameters</h4>
+ <ul><% method_args(namespace, method).each do |arg| %>
+ <li>
+ <%= arg %>:
+ <%= h(arg_text(namespace, method, arg)) %>
+ </li>
+ <% end %></ul>
+ </div><!-- section -->
+ <% end %>
+ </div><!-- section -->
<% end %>