Current section

Files

Jump to
ex_doc lib ex_doc formatter html templates module_template.eex
Raw

lib/ex_doc/formatter/html/templates/module_template.eex

<%= head_template(config, %{title: module.id, type: module.type}) %>
<%= sidebar_template(config, modules, exceptions, protocols) %>
<h1>
<small class="visible-xs"><%= config.project %> v<%= config.version %></small>
<%= module.id %>
<%= if module.type != :module do %>
<small><%= module.type %></small>
<% end %>
<%= if module.source do %>
<a href="<%= module.source %>" title="View Source" class="view-source" rel="help">
<i class="icon-code"></i>
</a>
<% end %>
</h1>
<%= if module.moduledoc do %>
<section id="moduledoc">
<%= module.moduledoc |> to_html() |> link_moduledoc_headings() %>
</section>
<% end %>
<%= unless Enum.empty?(types) and Enum.empty?(functions) and Enum.empty?(macros) and Enum.empty?(callbacks) do %>
<section id="summary" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#summary">
<i class="icon-link"></i>
</a>
Summary
</h1>
<%= summary_template "types", types %>
<%= summary_template "functions", functions %>
<%= summary_template "macros", macros %>
<%= summary_template "callbacks", callbacks %>
</section>
<% end %>
<%= unless Enum.empty?(types) do %>
<section id="types" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#types">
<i class="icon-link"></i>
</a>
Types
</h1>
<div class="types-list">
<%= for node <- types, do: detail_template(node, module) %>
</div>
</section>
<% end %>
<%= unless Enum.empty?(functions) do %>
<section id="functions" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#functions">
<i class="icon-link"></i>
</a>
Functions
</h1>
<%= for node <- functions, do: detail_template(node, module) %>
</section>
<% end %>
<%= unless Enum.empty?(macros) do %>
<section id="macros" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#macros">
<i class="icon-link"></i>
</a>
Macros
</h1>
<%= for node <- macros, do: detail_template(node, module) %>
</section>
<% end %>
<%= unless Enum.empty?(callbacks) do %>
<section id="callbacks" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#callbacks">
<i class="icon-link"></i>
</a>
Callbacks
</h1>
<%= for node <- callbacks, do: detail_template(node, module) %>
</section>
<% end %>
<%= footer_template(config) %>