Sha256: 6b21e7b9c00c521b6eb97e1cef1d80692bb56e6a1d06f1f9d78acaa410af07d8

Contents?: true

Size: 1.02 KB

Versions: 2

Compression:

Stored size: 1.02 KB

Contents

### <%= name %>

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

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

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

<% end -%>
<% if since -%>
* **Since** <%= since %>

<% end -%>
<% if see -%>
* **See also**
<% see.each do |sa| -%>
<%= sa[:name] %>
<%= sa[:text] %>
<% 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] %>`

<% if param[:types] -%>
Data type: `<%= param[:types].join(', ') -%>`

<% end -%>
<%= 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 defaults && defaults[param[:name]] -%>
Default value: <%= value_string(defaults[param[:name]]) %>

<% 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/classes_and_defines.erb
puppet-strings-1.2.0 lib/puppet-strings/markdown/templates/classes_and_defines.erb