improved documentation and bump version number

dsestero · dsestero · commit 62e887663fdd · 2015-04-30T11:13:06.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+##2015-04-30 - Release - 1.0.2
+###Summary
+Improved documentation, rspec tests added, license changed from CC-BY-SA-4.0 to Apache-2.0.
+
 ##2015-04-22 - Release - 1.0.1
 ###Summary
 Code polishing to be more compliant with puppet-lint suggestions.
diff --git a/README.markdown b/README.markdown
@@ -58,20 +58,49 @@ It is possible to install multiple versions of Java on a single node and to spec
 
 ##Reference
 
+###Classes
+
+####Public Classes
+
+* [`java::java_6`](#javajava_6): Installs open-jdk-6.
+* [`java::java_7`](#javajava_7): Installs open-jdk-7.
+
+###Defines
+
+####Public Defines
+
+* [`java::java`](#javajava): Install a specific version of java jdk and possibly sets update-alternative default
+
+####Private Defines
+
+* [`java::java_install`](#javajava_install): Installs a specific java open-jdk package
+* [`java::java_config`](#javajava_config): Configures the update-alternative default java
+
 ###`java::java_6`
 Installs OpenJDK-6 from the repositories.
 
 ###`java::java_7`
 Installs OpenJDK-7 from the repositories.
 
+###`java::java`
+Install a specific version of java jdk and possibly sets update-alternative default.
+If hiera defines a value for the parameter `java::java_default_version` on
+the target node the command `update-alternatives` is issued to set the
+default java accordingly.
+
+Declares all other defines in the java module needed for installing Java. Currently, these consists of `java::install`, and `java::config`.
+
 ####Parameters
 
-#####`java::java_default_version`
-If present in a JSON hiera file allows to set the default java command in the alternative system.
+#####`java_version`
+Specifies the java version to install. Valid options: '6' or '7'. Defaults to the resource title.
+
+#####`java_default_version`
+Specifies the default java in case multiple versions are installed. Valid options: '6' or '7'. Defaults to the hiera defined key `java::java_default_version`.
 
 ##Limitations
 
-At the moment the module targets only OpenJDK on Ubuntu platforms. Specifically, it is tested only on Ubuntu 10.04 and 12.04 distributions, although probably it will work also on more recent versions.
+At the moment the module targets only OpenJDK 6 and 7 on Ubuntu platforms. Specifically, it is tested only on Ubuntu 10.04 and 12.04 distributions, although probably it will work also on more recent versions.
 
 ##Development
 
diff --git a/manifests/init.pp b/manifests/init.pp
@@ -18,12 +18,9 @@
 #
 # Declares all other defines in the java module needed for installing Java.
 # Currently, these consists of java::install, and java::config.
-# Furthermore, the module provides two classes ready for use for installing
-# java-6 and java-7 using the defines.
 # If hiera defines a value for the parameter <tt>java_default_version</tt> on
-# the target node the
-# command <tt>update-alternatives</tt> is issued to set the default java
-# accordingly.
+# the target node the command <tt>update-alternatives</tt> is issued to set the
+# default java accordingly.
 #
 # Requires: see Modulefile
 #

Original file line number	Diff line number	Diff line change
`@@ -18,12 +18,9 @@`
`18`	`18`	`#`
`19`	`19`	`# Declares all other defines in the java module needed for installing Java.`
`20`	`20`	`# Currently, these consists of java::install, and java::config.`
`21`		`-# Furthermore, the module provides two classes ready for use for installing`
`22`		`-# java-6 and java-7 using the defines.`
`23`	`21`	`# If hiera defines a value for the parameter <tt>java_default_version</tt> on`
`24`		`-# the target node the`
`25`		`-# command <tt>update-alternatives</tt> is issued to set the default java`
`26`		`-# accordingly.`
	`22`	`+# the target node the command <tt>update-alternatives</tt> is issued to set the`
	`23`	`+# default java accordingly.`
`27`	`24`	`#`
`28`	`25`	`# Requires: see Modulefile`
`29`	`26`	`#`