Resolve puppet-strings documentation warnings

lib/puppet/type/splunk_config.rb

@@ -10,19 +10,21 @@
     desc 'splunk config'
   end
 
-  # rubocop:disable Lint/EmptyBlock
   newparam(:forwarder_installdir) do
+    desc 'Directory in which to install and manage Splunk Forwarder'
   end
 
   newparam(:forwarder_confdir) do
+    desc 'Directory for Splunk Forwarder configurations'
   end
 
   newparam(:server_installdir) do
+    desc 'Directory for server installation (maps to `enterprise_homedir`)'
   end
 
   newparam(:server_confdir) do
+    desc 'Directory for Splunk server configurations'
   end
-  # rubocop:enable Lint/EmptyBlock
 
   ## Generate purge parameters for the splunk_config type
   %i[

manifests/enterprise/install.pp

@@ -1,7 +1,6 @@
 # @summary
-#   Private class declared by Class[splunk::enterprise] to contain or define
-#   through additional platform specific sub-class, the required steps
-#   for successfully installing Splunk Enterprise
+#   Contain or define through additional platform specific sub-classes, the
+#   required steps for installing Splunk Enterprise.
 #
 class splunk::enterprise::install {
   if $facts['kernel'] == 'Linux' or $facts['kernel'] == 'SunOS' {

manifests/enterprise/password/seed.pp

@@ -1,7 +1,6 @@
 # @summary
-#   Implements the seeding and reseeding of the Splunk Enterprise admin password
-#   so it can be used outside of regular management of the whole stack to
-#   facilitate admin password resets through Bolt Plans
+#   Implements seeding and reseeding of Splunk Enterprise admin password to
+#   support admin password resets via Bolt.
 #
 # @param reset_seeded_password
 #   If set to true, deletes `password_config_file` to trigger Splunk's password

manifests/enterprise/service.pp

@@ -1,7 +1,5 @@
 # @summary
-#   Private class declared by Class[splunk::enterprise] to define a service
-#   as its understood by Puppet using a dynamic set of data or platform specific
-#   sub-classes
+#   Define and contain the services for Splunk Enterprise Server.
 #
 class splunk::enterprise::service {
   service { $splunk::enterprise::service_name:

manifests/forwarder/config.pp

@@ -1,7 +1,6 @@
 # @summary
-#   Private class declared by Class[splunk::forwarder] to contain all the
-#   configuration needed for a base install of the Splunk Universal
-#   Forwarder
+#   Contains all configuration needed for a base install of the Splunk
+#   Universal Forwarder
 #
 class splunk::forwarder::config {
   if $splunk::forwarder::seed_password {

manifests/forwarder/install.pp

@@ -1,7 +1,6 @@
 # @summary
-#   Private class declared by Class[splunk::forwarder] to contain or define
-#   through additional platform specific sub-class, the required steps
-#   for successfully installing the Splunk Universal Forwarder
+#   Contains or define through additional platform specific sub-classes, the
+#   steps for installing the Splunk Universal Forwarder
 #
 class splunk::forwarder::install {
   $_package_source = $splunk::forwarder::manage_package_source ? {

manifests/forwarder/password/manage.pp

@@ -1,10 +1,8 @@
 # @summary
-#   Implements the direct management of the Splunk Forwarder admin password
-#   so it can be used outside of regular management of the whole stack to
-#   facilitate admin password resets through Bolt Plans.
+#   Allows direct management of the Forwarder admin password to support
+#   password resets through Bolt Plans.
 #
-#   Note: Entirely done to make this implementation consistent with the method
-#   used to manage admin password seeding.
+#   Note: This is present entirely for consistency with admin password seeding.
 #
 # @param manage_password
 #   If set to true, Manage the contents of splunk.secret and passwd.

manifests/forwarder/password/seed.pp

@@ -1,7 +1,6 @@
 # @summary
-#   Implements the seeding and reseeding of the Splunk Forwarder admin password
-#   so it can be used outside of regular management of the whole stack to
-#   facilitate admin password resets through Bolt Plans
+#   Implements seeding and reseeding of Forwarder admin password to support
+#   admin password resets via Bolt.
 #
 # @param reset_seeded_password
 #   If set to true, deletes `password_config_file` to trigger Splunk's password

manifests/forwarder/service.pp

@@ -1,7 +1,5 @@
 # @summary
-#   Private class declared by Class[splunk::forwarder] to define a service as
-#   its understood by Puppet using a dynamic set of data or platform specific
-#   sub-classes
+#   Define and contain the services for Splunk Forwarder.
 #
 class splunk::forwarder::service {
   service { $splunk::forwarder::service_name:

manifests/params.pp

@@ -1,9 +1,6 @@
 # @summary
-#   This class takes a small number of arguments (can be set through Hiera) and
-#   generates sane default values installation media names and locations.
-#   Default ports can also be specified here. This is a parameters class, and
-#   contributes no resources to the graph. Rather, it only sets values for
-#   parameters to be consumed by child classes.
+#   Accepts settings, and provides default values for module parameters.
+#   Parameters class only: contributes no resources to the graph.
 #
 # @param version
 #   The version of Splunk to install. This will be in the form x.y.z; e.g.

types/entinstalloptions.pp

@@ -1 +1,2 @@
+# @summary Type alias for Enterprise Server install options.
 type Splunk::Entinstalloptions = Variant[Tuple[Hash,Hash,String,3,default], Array[String[1]]]

types/fwdinstalloptions.pp

@@ -1 +1,2 @@
+# @summary Type alias for Splunk forwarder install options.
 type Splunk::Fwdinstalloptions = Variant[Tuple[Hash,String,1,default], Array[String[1]]]