Contents

### `<%= name %>`

Type: <%= type %>

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

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

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

<% end -%>
<% if todo -%>
* **TODO** <%= todo %>

<% end -%>
<% if note -%>
* **Note** <%= note %>

<% end -%>
<% if examples -%>
#### Examples

<% examples.each do |eg| -%>
##### <%= eg[:name] %>

```puppet
<%= eg[:text] %>
```

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

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

<% elsif sig.summary -%>
<%= sig.summary %>

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

<% end -%>
<% if sig.note -%>
* **Note** <%= sig.note %>

<% 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.examples -%>
##### Examples

<% sig.examples.each do |eg| -%>
###### <%= eg[:name] %>

```puppet
<%= eg[: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 -%>
<% if sig.enums_for_param(param[:name]) -%>
Options:

<% sig.enums_for_param(param[:name]).each do |e| -%>
* **<%= e[:opt_name] %>**: <%= e[:opt_text] %>
<% end -%>

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

Version data entries

1 entries across 1 versions & 1 rubygems

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