Skip to content

Commit 0be6281

Browse files
dsesterodsestero
committed
documentation with puppet strings
1 parent 7694cf4 commit 0be6281

11 files changed

Lines changed: 83 additions & 96 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
##2018-01-09 - Release - 2.0.0
22
###Summary
33
Facts revision to comply with modern Puppet 4/5 recommended style.
4+
Adds documentation generated with puppet strings.
45
Attention: the module is no more compatible with Puppet 3.
56

67
##2017-05-12 - Release - 1.2.1

‎docs/puppet_classes/java_3A_3Ajava_6.html‎

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -79,10 +79,6 @@ <h2>Overview</h2>
7979

8080
<p>This class installs Java-6.</p>
8181

82-
<p>Parameters:</p>
83-
84-
<p>none</p>
85-
8682
<p>Actions:</p>
8783

8884
<p>Installs Java-6 by declaring the <code>java</code> define.</p>
@@ -105,13 +101,13 @@ <h2>Overview</h2>
105101
<pre class="lines">
106102

107103

108-
18
109-
19
110-
20
111-
21</pre>
104+
14
105+
15
106+
16
107+
17</pre>
112108
</td>
113109
<td>
114-
<pre class="code"><span class="info file"># File 'manifests/java_6.pp', line 18</span>
110+
<pre class="code"><span class="info file"># File 'manifests/java_6.pp', line 14</span>
115111

116112
class java::java_6 {
117113

‎docs/puppet_classes/java_3A_3Ajava_7.html‎

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -79,10 +79,6 @@ <h2>Overview</h2>
7979

8080
<p>This class installs Java-7.</p>
8181

82-
<p>Parameters:</p>
83-
84-
<p>none</p>
85-
8682
<p>Actions:</p>
8783

8884
<p>Installs Java-7 by declaring the <code>java</code> define.</p>
@@ -105,13 +101,13 @@ <h2>Overview</h2>
105101
<pre class="lines">
106102

107103

108-
18
109-
19
110-
20
111-
21</pre>
104+
14
105+
15
106+
16
107+
17</pre>
112108
</td>
113109
<td>
114-
<pre class="code"><span class="info file"># File 'manifests/java_7.pp', line 18</span>
110+
<pre class="code"><span class="info file"># File 'manifests/java_7.pp', line 14</span>
115111

116112
class java::java_7 {
117113

‎docs/puppet_classes/java_3A_3Ajava_8.html‎

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -79,10 +79,6 @@ <h2>Overview</h2>
7979

8080
<p>This class installs Java-8.</p>
8181

82-
<p>Parameters:</p>
83-
84-
<p>none</p>
85-
8682
<p>Actions:</p>
8783

8884
<p>Installs Java-8 by declaring the <code>java</code> define.</p>
@@ -105,13 +101,13 @@ <h2>Overview</h2>
105101
<pre class="lines">
106102

107103

108-
18
109-
19
110-
20
111-
21</pre>
104+
14
105+
15
106+
16
107+
17</pre>
112108
</td>
113109
<td>
114-
<pre class="code"><span class="info file"># File 'manifests/java_8.pp', line 18</span>
110+
<pre class="code"><span class="info file"># File 'manifests/java_8.pp', line 14</span>
115111

116112
class java::java_8 {
117113

‎docs/puppet_defined_types/java.html‎

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -73,20 +73,8 @@ <h2>Overview</h2>
7373
<div class="docstring">
7474
<div class="discussion">
7575

76-
<p>Define: java</p>
77-
7876
<p>This module manages Java.</p>
7977

80-
<p>Parameters:</p>
81-
82-
<p>$java_version:: The java version. Possible values at this time are
83-
<code>6</code> and <code>7</code>. Defaults to the resource&#39;s title.</p>
84-
85-
<p>$java_default_version:: The java default version. Possible values at this
86-
time are <code>6</code> and <code>7</code>. If different than
87-
<code>undef</code> it will be used to configure the alternative system.
88-
Defaults to <code>undef</code>.</p>
89-
9078
<p>Actions:</p>
9179

9280
<p>Declares all other defines in the java module needed for installing Java.
@@ -112,25 +100,38 @@ <h2>Overview</h2>
112100
<span class='name'>java_version</span>
113101

114102

115-
<span class='type'>(<tt>Any</tt>)</span>
103+
<span class='type'>(<tt>Integer</tt>)</span>
116104

117105

118106
<em class="default">(defaults to: <tt>$title</tt>)</em>
119107

120108

109+
&mdash;
110+
<div class='inline'>
111+
<p>the java version. Possible values at this time are <code>6</code> and
112+
<code>7</code>.</p>
113+
</div>
114+
121115
</li>
122116

123117
<li>
124118

125119
<span class='name'>java_default_version</span>
126120

127121

128-
<span class='type'>(<tt>Any</tt>)</span>
122+
<span class='type'>(<tt>Integer</tt>)</span>
129123

130124

131125
<em class="default">(defaults to: <tt>hiera(&#39;java::java_default_version&#39;, undef)</tt>)</em>
132126

133127

128+
&mdash;
129+
<div class='inline'>
130+
<p>the java default version. Possible values at this time are <code>6</code>
131+
and <code>7</code>. If different than <code>undef</code> it will be used to
132+
configure the alternative system.</p>
133+
</div>
134+
134135
</li>
135136

136137
</ul>
@@ -143,20 +144,20 @@ <h2>Overview</h2>
143144
<pre class="lines">
144145

145146

147+
26
148+
27
149+
28
150+
29
146151
30
147152
31
148153
32
149154
33
150155
34
151156
35
152-
36
153-
37
154-
38
155-
39
156-
40</pre>
157+
36</pre>
157158
</td>
158159
<td>
159-
<pre class="code"><span class="info file"># File 'manifests/init.pp', line 30</span>
160+
<pre class="code"><span class="info file"># File 'manifests/init.pp', line 26</span>
160161

161162
define java (
162163
$java_version = $title,

‎docs/puppet_defined_types/java_3A_3Ainstall_config.html‎

Lines changed: 28 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,6 @@ <h2>Overview</h2>
7373
<div class="docstring">
7474
<div class="discussion">
7575

76-
<p>= Define: java::install_config</p>
77-
7876
<p>Configures Java. It is intended to be called by java::java.</p>
7977

8078
<p>== Actions:</p>
@@ -92,25 +90,38 @@ <h2>Overview</h2>
9290

9391
<li>
9492

95-
<span class='name'>java_default_version</span>
93+
<span class='name'>java_version</span>
9694

9795

98-
<span class='type'>(<tt>Any</tt>)</span>
96+
<span class='type'>(<tt>Integer</tt>)</span>
9997

10098

99+
<em class="default">(defaults to: <tt>$title</tt>)</em>
100+
101+
102+
&mdash;
103+
<div class='inline'>
104+
<p>the java version. Possible values at this time are <code>6</code> and
105+
<code>7</code>.</p>
106+
</div>
101107

102108
</li>
103109

104110
<li>
105111

106-
<span class='name'>java_version</span>
112+
<span class='name'>java_default_version</span>
107113

108114

109-
<span class='type'>(<tt>Any</tt>)</span>
115+
<span class='type'>(<tt>Integer</tt>)</span>
110116

111117

112-
<em class="default">(defaults to: <tt>$title</tt>)</em>
113118

119+
&mdash;
120+
<div class='inline'>
121+
<p>the java default version. Possible values at this time are <code>6</code>
122+
and <code>7</code>. If different than <code>undef</code> it will be used to
123+
configure the alternative system.</p>
124+
</div>
114125

115126
</li>
116127

@@ -124,14 +135,6 @@ <h2>Overview</h2>
124135
<pre class="lines">
125136

126137

127-
14
128-
15
129-
16
130-
17
131-
18
132-
19
133-
20
134-
21
135138
22
136139
23
137140
24
@@ -152,10 +155,18 @@ <h2>Overview</h2>
152155
39
153156
40
154157
41
155-
42</pre>
158+
42
159+
43
160+
44
161+
45
162+
46
163+
47
164+
48
165+
49
166+
50</pre>
156167
</td>
157168
<td>
158-
<pre class="code"><span class="info file"># File 'manifests/install_config.pp', line 14</span>
169+
<pre class="code"><span class="info file"># File 'manifests/install_config.pp', line 22</span>
159170

160171
define java::install_config ($java_default_version, $java_version = $title,) {
161172
case $facts[&#39;os&#39;][&#39;family&#39;] {

‎manifests/init.pp‎

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,14 @@
1-
# Define: java
2-
#
31
# This module manages Java.
42
#
5-
# Parameters:
6-
#
7-
# $java_version:: The java version. Possible values at this time are
8-
# <tt>6</tt> and <tt>7</tt>.
9-
# Defaults to the resource's title.
3+
# @param java_version [Integer] the java version.
4+
# Possible values at this time are
5+
# <tt>6</tt> and <tt>7</tt>.
106
#
11-
# $java_default_version:: The java default version. Possible values at this time
12-
# are <tt>6</tt> and <tt>7</tt>.
13-
# If different than +undef+ it will be used to configure
14-
# the alternative system.
15-
# Defaults to +undef+.
7+
# @param java_default_version [Integer] the java default version.
8+
# Possible values at this time are
9+
# <tt>6</tt> and <tt>7</tt>.
10+
# If different than +undef+ it will be used to configure
11+
# the alternative system.
1612
#
1713
# Actions:
1814
#

‎manifests/install_config.pp‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
1-
# = Define: java::install_config
2-
#
31
# Configures Java.
42
# It is intended to be called by java::java.
53
#
4+
# @param java_version [Integer] the java version.
5+
# Possible values at this time are
6+
# <tt>6</tt> and <tt>7</tt>.
7+
#
8+
# @param java_default_version [Integer] the java default version.
9+
# Possible values at this time are
10+
# <tt>6</tt> and <tt>7</tt>.
11+
# If different than +undef+ it will be used to configure
12+
# the alternative system.
13+
#
614
# == Actions:
715
#
816
# Sets up the default java according to the parameter

‎manifests/java_6.pp‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,5 @@
1-
# Class: java::java_6
2-
#
31
# This class installs Java-6.
42
#
5-
# Parameters:
6-
#
7-
# none
8-
#
93
# Actions:
104
#
115
# Installs Java-6 by declaring the +java+ define.

‎manifests/java_7.pp‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,5 @@
1-
# Class: java::java_7
2-
#
31
# This class installs Java-7.
42
#
5-
# Parameters:
6-
#
7-
# none
8-
#
93
# Actions:
104
#
115
# Installs Java-7 by declaring the +java+ define.

0 commit comments

Comments
 (0)