Sha256: af1715e59e4ecc263ce2723ff0c37c27d94ca0e1c04609ace42036e44c28f88d

Contents?: true

Size: 1.17 KB

Versions: 13

Compression:

Stored size: 1.17 KB

Contents

<% argument_tags = options[:argument_tags] %>
<% has_accepted_values = argument_tags.any? { |e| Array(e.accepted_values).any? } %>

<table>
  <thead>
    <tr>
      <th>Name</th>
      <th>Type</th>
      <% if has_accepted_values %><th>Accepted Values</th><% end %>
      <th>Required?</th>
      <th>Description</th>
    </tr>
  </thead>

  <tbody>
    <% argument_tags.each do |tag| %>
      <tr>
        <td><code class="argument-name"><%= h tag.name %></code></td>
        <td><span class="argument-type"><%= tag.type %></span></td>
        
        <% if has_accepted_values %>
          <td>
            <ul class="argument-values">
              <% (tag.accepted_values || []).each do |value| %>
                <li><%= value %></li>
              <% end %>
            </ul>
          </td>
        <% end %>

        <td>
          <% if tag.is_required %>
            <em class="argument-required">Yes</em>
          <% else %>
            <em class="argument-optional">No</em>
          <% end %>
        </td>

        <td>
          <% if !tag.text.empty? %>
            <%= html_markup_markdown(tag.text) %>
          <% end %>
        </td>
      </tr>
    <% end %>
  </tbody>
</table>

Version data entries

13 entries across 13 versions & 1 rubygems

Version Path
yard-api-1.1.2 templates/api/tags/html/argument/_table.erb
yard-api-1.1.1 templates/api/tags/html/argument/_table.erb
yard-api-1.1.0 templates/api/tags/html/argument/_table.erb
yard-api-1.0.1 templates/api/tags/html/argument/_table.erb
yard-api-1.0.0 templates/api/tags/html/argument/_table.erb
yard-api-0.3.7 templates/api/tags/html/argument/_table.erb
yard-api-0.3.6 templates/api/tags/html/argument/_table.erb
yard-api-0.3.5 templates/api/tags/html/argument/_table.erb
yard-api-0.3.4 templates/api/tags/html/argument/_table.erb
yard-api-0.3.3 templates/api/tags/html/argument/_table.erb
yard-api-0.3.2 templates/api/tags/html/argument/_table.erb
yard-api-0.3.1 templates/api/tags/html/argument/_table.erb
yard-api-0.3.0 templates/api/tags/html/argument/_table.erb