(maint) change template logic and add test
This commit is contained in:
parent
5a283c2212
commit
09a5d3e4ff
|
@ -1,7 +1,15 @@
|
||||||
### <%= name %>
|
### <%= name %>
|
||||||
|
|
||||||
<%= text || summary || "The #{name} class." %>
|
<% if text -%>
|
||||||
|
<%= text %>
|
||||||
|
|
||||||
|
<% elsif summary -%>
|
||||||
|
<%= summary %>
|
||||||
|
|
||||||
|
<% else -%>
|
||||||
|
<%= "The #{name} class." %>
|
||||||
|
|
||||||
|
<% end -%>
|
||||||
<% if since -%>
|
<% if since -%>
|
||||||
* **Since** <%= since %>
|
* **Since** <%= since %>
|
||||||
|
|
||||||
|
|
|
@ -1,8 +1,16 @@
|
||||||
### <%= name %>
|
### <%= name %>
|
||||||
Type: <%= type %>
|
Type: <%= type %>
|
||||||
|
|
||||||
<%= text || summary || "The #{name} function." %>
|
<% if text -%>
|
||||||
|
<%= text %>
|
||||||
|
|
||||||
|
<% elsif summary -%>
|
||||||
|
<%= summary %>
|
||||||
|
|
||||||
|
<% else -%>
|
||||||
|
<%= "The #{name} class." %>
|
||||||
|
|
||||||
|
<% end -%>
|
||||||
<% signatures.each do |sig| -%>
|
<% signatures.each do |sig| -%>
|
||||||
#### `<%= sig.signature %>`
|
#### `<%= sig.signature %>`
|
||||||
|
|
||||||
|
|
|
@ -1,7 +1,15 @@
|
||||||
### <%= name %>
|
### <%= name %>
|
||||||
|
|
||||||
<%= text || summary || "The #{name} type." %>
|
<% if text -%>
|
||||||
|
<%= text %>
|
||||||
|
|
||||||
|
<% elsif summary -%>
|
||||||
|
<%= summary %>
|
||||||
|
|
||||||
|
<% else -%>
|
||||||
|
<%= "The #{name} type." %>
|
||||||
|
|
||||||
|
<% end -%>
|
||||||
<% if since -%>
|
<% if since -%>
|
||||||
* **Since** <%= since %>
|
* **Since** <%= since %>
|
||||||
|
|
||||||
|
|
|
@ -2,6 +2,8 @@
|
||||||
|
|
||||||
## Classes
|
## Classes
|
||||||
* [`klass`](#klass): A simple class.
|
* [`klass`](#klass): A simple class.
|
||||||
|
* [`noparams`](#noparams): Overview for class noparams
|
||||||
|
* [`noparams_desc`](#noparams_desc):
|
||||||
## Defined types
|
## Defined types
|
||||||
* [`klass::dt`](#klassdt): A simple defined type.
|
* [`klass::dt`](#klassdt): A simple defined type.
|
||||||
## Resource types
|
## Resource types
|
||||||
|
@ -76,6 +78,16 @@ Third param.
|
||||||
Default value: 'hi'
|
Default value: 'hi'
|
||||||
|
|
||||||
|
|
||||||
|
### noparams
|
||||||
|
|
||||||
|
Overview for class noparams
|
||||||
|
|
||||||
|
|
||||||
|
### noparams_desc
|
||||||
|
|
||||||
|
The noparams_desc class.
|
||||||
|
|
||||||
|
|
||||||
## Defined types
|
## Defined types
|
||||||
|
|
||||||
### klass::dt
|
### klass::dt
|
||||||
|
|
|
@ -35,6 +35,11 @@ class klass (
|
||||||
) inherits foo::bar {
|
) inherits foo::bar {
|
||||||
}
|
}
|
||||||
|
|
||||||
|
# Overview for class noparams
|
||||||
|
class noparams () {}
|
||||||
|
|
||||||
|
class noparams_desc () {}
|
||||||
|
|
||||||
# An overview for a simple defined type.
|
# An overview for a simple defined type.
|
||||||
# @summary A simple defined type.
|
# @summary A simple defined type.
|
||||||
# @since 1.1.0
|
# @since 1.1.0
|
||||||
|
|
Loading…
Reference in New Issue