Sha256: ce41ec600986e1a6f6ab8ea9252c47c668824849bb7d804cf6dd421a52a7895b
Contents?: true
Size: 1.69 KB
Versions: 3
Compression:
Stored size: 1.69 KB
Contents
### <a name="<%= link %>"></a>`<%= name %>`
<% if text -%>
<%= text %>
<% elsif summary -%>
<%= summary %>
<% else -%>
<%= "The #{name} class." %>
<% end -%>
<% if deprecated -%>
* **DEPRECATED** <%= deprecated %>
<% end -%>
<% if todo -%>
* **TODO** <%= todo %>
<% end -%>
<% if note -%>
* **Note** <%= note %>
<% end -%>
<% if since -%>
* **Since** <%= since %>
<% end -%>
<% if see -%>
* **See also**
<% see.each do |sa| -%>
<% if sa[:name] -%>
<%= " * #{sa[:name]}" %>
<% end -%>
<% if sa[:text] -%>
<%= " * #{sa[:text]}" %>
<% end -%>
<% end -%>
<% end -%>
<% if examples -%>
#### Examples
<% examples.each do |eg| -%>
##### <%= eg[:name] %>
```puppet
<%= eg[:text] %>
```
<% end -%>
<% end -%>
<% if params -%>
#### Parameters
The following parameters are available in the `<%= name %>` <%= @type %>:
<% params.each do |param| -%>
* [`<%= param[:name] %>`](#<%= param[:link] %>)
<% end -%>
<% params.each do |param| -%>
##### <a name="<%= param[:link] %>"></a>`<%= param[:name] %>`
<% if param[:types] -%>
Data type:<%= code_maybe_block(param[:types].join(', ')) %>
<% end -%>
<%= param[:text] %>
<% if options_for_param(param[:name]) -%>
Options:
<% options_for_param(param[:name]).each do |o| -%>
<% if o[:opt_types] -%>
* **<%= o[:opt_name] %>** `<%= o[:opt_types][0] %>`: <%= o[:opt_text] %>
<% else -%>
* **<%= o[:opt_name] %>**: <%= o[:opt_text] %>
<% end -%>
<% 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 -%>
<% if defaults && defaults[param[:name]] -%>
Default value:<%= code_maybe_block(defaults[param[:name]]) %>
<% end -%>
<% end -%>
<% end -%>
Version data entries
3 entries across 3 versions & 1 rubygems