Sha256: 804427a0ae3ebff9619a53113c96b8aa9c7df1f57f281fc06cac5413b26f7221
Contents?: true
Size: 1.61 KB
Versions: 4
Compression:
Stored size: 1.61 KB
Contents
### <a name="<%= link %>"></a>`<%= 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
4 entries across 4 versions & 1 rubygems