Sha256: e84b42eaf927e6cc8c3f750f1135185fe4c439aaf0b65fda42c334c59c42d79e
Contents?: true
Size: 1.14 KB
Versions: 8
Compression:
Stored size: 1.14 KB
Contents
### <a name="<%= link %>"></a>`<%= name %>`
#### `<%= signature %>`
<% if text -%>
<%= text %>
<% elsif summary -%>
<%= summary %>
<% else -%>
<%= "The #{name} function." %>
<% end -%>
<% if note -%>
* **Note** <%= note %>
<% end -%>
<% if return_type -%>
Returns: `<%= return_type %>`<% if return_val %> <%= return_val %><% end %>
<% end -%>
<% if raises -%>
Raises:
<% raises.each do |r| -%>
* <%= error_type(r[:text]) %> <%= error_text(r[:text]) %>
<% end -%>
<% end -%>
<% if examples -%>
##### Examples
<% examples.each do |eg| -%>
###### <%= eg[:name] %>
```puppet
<%= eg[:text] %>
```
<% end -%>
<% end -%>
<% if params -%>
<% params.each do |param| -%>
##### `<%= param[:name] %>`
Data type:<%= code_maybe_block(param[:types][0]) %>
<%= param[:text] %>
<% if options_for_param(param[:name]) -%>
Options:
<% options_for_param(param[:name]).each do |o| -%>
* **<%= o[:opt_name] %>** `<%= o[:opt_types][0] %>`: <%= o[:opt_text] %>
<% end -%>
<% end -%>
<% if enums_for_param(param[:name]) -%>
Options:
<% enums_for_param(param[:name]).each do |e| -%>
* **<%= e[:opt_name] %>**: <%= e[:opt_text] %>
<% end -%>
<% end -%>
<% end -%>
<% end -%>
Version data entries
8 entries across 8 versions & 1 rubygems