Make Puppet Doc compliant with RDoc markup language

antoineco · antoineco · commit 2a86dfce88e1 · 2014-08-04T23:15:33.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+###1.1.2
+
+* Make Puppet Doc compliant with RDoc markup language
+
 ###1.1.1
 
 * Add parameters validation
diff --git a/manifests/init.pp b/manifests/init.pp
@@ -1,29 +1,29 @@
-# === Class: oracle_java
+# == Class: oracle_java
 #
 # This module installs Oracle Java from official RPM packages
 #
-# == Parameters
+# === Parameters:
 #
-# $version:
+# [*version*]
 #   Java SE version to install (valid format: 'major'u'minor' or just 'major')
-# $type:
+# [*type*]
 #   envionment type to install (valid: 'jre'|'jdk')
 #
-# === Actions
+# === Actions:
 #
 # - Install Oracle jre/jdk
 #
-# === Requires
+# === Requires:
 #
-# - puppetlabs/stdlib module
-# - 'wget' and 'sed' packages
+# * puppetlabs/stdlib module
+# * 'wget' and 'sed' packages
 #
 # === Sample Usage:
 #
-# class { '::oracle_java':
-#   version => '8u5',
-#   type    => 'jdk'
-# }
+#  class { '::oracle_java':
+#    version => '8u5',
+#    type    => 'jdk'
+#  }
 #
 class oracle_java ($version = '8', $type = 'jre') {
   # parameters validation

Original file line number	Diff line number	Diff line change
`@@ -1,29 +1,29 @@`
`1`		`-# === Class: oracle_java`
	`1`	`+# == Class: oracle_java`
`2`	`2`	`#`
`3`	`3`	`# This module installs Oracle Java from official RPM packages`
`4`	`4`	`#`
`5`		`-# == Parameters`
	`5`	`+# === Parameters:`
`6`	`6`	`#`
`7`		`-# $version:`
	`7`	`+# [version]`
`8`	`8`	`# Java SE version to install (valid format: 'major'u'minor' or just 'major')`
`9`		`-# $type:`
	`9`	`+# [type]`
`10`	`10`	`# envionment type to install (valid: 'jre'\|'jdk')`
`11`	`11`	`#`
`12`		`-# === Actions`
	`12`	`+# === Actions:`
`13`	`13`	`#`
`14`	`14`	`# - Install Oracle jre/jdk`
`15`	`15`	`#`
`16`		`-# === Requires`
	`16`	`+# === Requires:`
`17`	`17`	`#`
`18`		`-# - puppetlabs/stdlib module`
`19`		`-# - 'wget' and 'sed' packages`
	`18`	`+# * puppetlabs/stdlib module`
	`19`	`+# * 'wget' and 'sed' packages`
`20`	`20`	`#`
`21`	`21`	`# === Sample Usage:`
`22`	`22`	`#`
`23`		`-# class { '::oracle_java':`
`24`		`-# version => '8u5',`
`25`		`-# type => 'jdk'`
`26`		`-# }`
	`23`	`+# class { '::oracle_java':`
	`24`	`+# version => '8u5',`
	`25`	`+# type => 'jdk'`
	`26`	`+# }`
`27`	`27`	`#`
`28`	`28`	`class oracle_java ($version = '8', $type = 'jre') {`
`29`	`29`	`# parameters validation`