Sha256: 8c7d3f33e7fbc538609f9bbd12597359b65a7bb33a95f2cfe91eddc4b7b8322a

Contents?: true

Size: 902 Bytes

Versions: 2

Compression:

Stored size: 902 Bytes

Contents

### <%= name %>
Type: <%= type %>

<% if text -%>
<%= text %>

<% elsif summary -%>
<%= summary %>

<% else -%>
<%= "The #{name} class." %>

<% end -%>
<% signatures.each do |sig| -%>
#### `<%= sig.signature %>`

<% if sig.text -%>
<%= sig.text %>

<% end -%>
<% if sig.return_type -%>
Returns: `<%= sig.return_type %>`<% if sig.return_val %> <%= sig.return_val %><% end %>

<% end -%>
<% if raises -%>
Raises:
<% raises.each do |r| -%>
* <%= error_type(r[:text]) %> <%= error_text(r[:text]) %>
<% end -%>

<% end -%>
<% if sig.params -%>
<% sig.params.each do |param| -%>
##### `<%= param[:name]  %>`

Data type: `<%= param[:types][0] %>`

<%= param[:text] %>

<% if sig.options_for_param(param[:name]) -%>
Options:

<% sig.options_for_param(param[:name]).each do |o| -%>
* **<%= o[:opt_name] %>** `<%= o[:opt_types][0] %>`: <%= o[:opt_text] %>
<% end -%>

<% end -%>
<% end -%>
<% end -%>
<% end -%>

Version data entries

2 entries across 2 versions & 1 rubygems

Version Path
puppet-strings-1.2.1 lib/puppet-strings/markdown/templates/function.erb
puppet-strings-1.2.0 lib/puppet-strings/markdown/templates/function.erb