diff options
| author | Seba Gamboa <[email protected]> | 2015-10-12 14:13:11 -0200 |
|---|---|---|
| committer | Seba Gamboa <[email protected]> | 2015-10-12 14:13:11 -0200 |
| commit | 89853c9da5d1274612f28ef8cb3e1ab22501e856 (patch) | |
| tree | 733ac18fbbd60fd492b65131bfa313015eba9089 /templates | |
| parent | d2538783741de8681bdd0fa7e7e268bc24eddb4a (diff) | |
| parent | 4d1b7420a4aaaaa8da14091d95ed007f4efb93ab (diff) | |
| download | yard-mruby-89853c9da5d1274612f28ef8cb3e1ab22501e856.tar.gz yard-mruby-89853c9da5d1274612f28ef8cb3e1ab22501e856.zip | |
Merge pull request #8 from takahashim/typedef_handler
support typedef documentation
Diffstat (limited to 'templates')
| -rw-r--r-- | templates/default/header/html/setup.rb | 8 | ||||
| -rw-r--r-- | templates/default/header/html/typedef_summary.erb | 11 |
2 files changed, 19 insertions, 0 deletions
diff --git a/templates/default/header/html/setup.rb b/templates/default/header/html/setup.rb index 204f823..7bb0159 100644 --- a/templates/default/header/html/setup.rb +++ b/templates/default/header/html/setup.rb @@ -5,6 +5,7 @@ def init sections :header, :pre_docstring, T('docstring'), :includes, :function_summary, [:item_summary], :define_summary, [T('docstring')], + :typedef_summary, [T('docstring')], :function_details_list, [T('function_details')] end @@ -22,3 +23,10 @@ def define_listing @defines = object.defines @defines end + +def typedef_listing + return @typedefs if @typedefs + + @typedefs = object.typedefs + @typedefs +end diff --git a/templates/default/header/html/typedef_summary.erb b/templates/default/header/html/typedef_summary.erb new file mode 100644 index 0000000..001ab2d --- /dev/null +++ b/templates/default/header/html/typedef_summary.erb @@ -0,0 +1,11 @@ +<% if typedef_listing.size > 0 %> + <h2>Typedef Summary</h2> + <dl class="constants"> + <% typedef_listing.each do |typedef| %> + <dt id="<%= anchor_for(typedef) %>" class="<%= typedef.has_tag?(:deprecated) ? 'deprecated' : '' %>"><small>typedef</small> <%= typedef.name %> + <%= yieldall :object => typedef %> + </dt> + <dd><pre class="code"><%#= format_constant typedef.value %></pre></dd> + <% end %> + </dl> +<% end %> |