Merge pull request #119 from bastelfreak/docs4

document all parameters with puppet-strings

.puppet-lint.rc

@@ -2,4 +2,3 @@
 # https://voxpupuli.org/docs/updating-files-managed-with-modulesync/
 
 --fail-on-warnings
---no-parameter_documentation-check

.sync.yml

@@ -2,3 +2,4 @@
 .puppet-lint.rc:
   enabled_lint_checks:
     - parameter_types
+    - parameter_documentation

REFERENCE.md

@@ -0,0 +1,66 @@
+# Reference
+
+<!-- DO NOT EDIT: This document was generated by Puppet Strings -->
+
+## Table of Contents
+
+### Classes
+
+* [`catalog_diff::viewer`](#catalog_diff--viewer): installs the catalog-diff viewer
+
+## Classes
+
+### <a name="catalog_diff--viewer"></a>`catalog_diff::viewer`
+
+installs the catalog-diff viewer
+
+#### Parameters
+
+The following parameters are available in the `catalog_diff::viewer` class:
+
+* [`remote`](#-catalog_diff--viewer--remote)
+* [`password`](#-catalog_diff--viewer--password)
+* [`revision`](#-catalog_diff--viewer--revision)
+* [`port`](#-catalog_diff--viewer--port)
+* [`listen_ip`](#-catalog_diff--viewer--listen_ip)
+
+##### <a name="-catalog_diff--viewer--remote"></a>`remote`
+
+Data type: `String`
+
+the url to the git repo of the catalog diff viewer
+
+Default value: `'https://github.com/voxpupuli/puppet-catalog-diff-viewer.git'`
+
+##### <a name="-catalog_diff--viewer--password"></a>`password`
+
+Data type: `String`
+
+password for basic authentication
+
+Default value: `'puppet'`
+
+##### <a name="-catalog_diff--viewer--revision"></a>`revision`
+
+Data type: `String`
+
+the desired branch/rev that you want to checkout
+
+Default value: `'master'`
+
+##### <a name="-catalog_diff--viewer--port"></a>`port`
+
+Data type: `Integer`
+
+where apache will listen on
+
+Default value: `1495`
+
+##### <a name="-catalog_diff--viewer--listen_ip"></a>`listen_ip`
+
+Data type: `String`
+
+the desired ip adddress to listen on
+
+Default value: `$facts['networking']['ip']`
+

lib/puppet/face/catalog/pull.rb

@@ -19,7 +19,7 @@
     option '--new_server=' do
       summary 'This the valid certificate name or alt name for your old server'
 
-      default_to { Facter.value('fqdn') }
+      default_to { Facter.value('networking.fqdn') }
     end
 
     option '--threads=' do

lib/puppet/face/catalog/seed.rb

@@ -12,7 +12,7 @@
 
     option '--master_server SERVER' do
       summary 'The server from which to download the catalogs from'
-      default_to { Facter.value('fqdn') }
+      default_to { Facter.value('networkin.fqdn') }
     end
 
     option '--certless' do

manifests/viewer.pp

@@ -1,3 +1,12 @@
+#
+# @summary installs the catalog-diff viewer
+#
+# @param remote the url to the git repo of the catalog diff viewer
+# @param password password for basic authentication
+# @param revision the desired branch/rev that you want to checkout
+# @param port where apache will listen on
+# @param listen_ip the desired ip adddress to listen on
+#
 class catalog_diff::viewer (
   String  $remote    = 'https://github.com/voxpupuli/puppet-catalog-diff-viewer.git',
   String  $password  = 'puppet',