add prefix to descriptions

Author: h0tw1r3

REFERENCE.md

@@ -39,7 +39,7 @@
 * `puppetdb::database::default_read_grant`: grant read permissions to $database_read_only_username by default, for new tables created by $database_username
 * `puppetdb::database::postgresql_ssl_rules`: manage the pg_ident.conf and pg_hba.conf files
 * `puppetdb::database::read_grant`: grant read-only permissions to $database_read_only_username for all objects in $schema of $database_name
-* `puppetdb::database::read_only_user`: A define type to manage the creation of a read-only postgres users. In particular, it manages the necessary grants to enable such a user to h
+* `puppetdb::database::read_only_user`: manage the creation of a read-only postgres users
 
 ### Resource types
 

manifests/database/default_read_grant.pp

@@ -1,4 +1,4 @@
-# grant read permissions to $database_read_only_username by default, for new tables created by $database_username
+# @summary grant read permissions to $database_read_only_username by default, for new tables created by $database_username
 #
 # @api private
 define puppetdb::database::default_read_grant (

manifests/database/postgresql.pp

@@ -1,4 +1,4 @@
-# create the PuppetDB postgresql database
+# @summary create the PuppetDB postgresql database
 #
 # @param listen_addresses
 #   The `listen_address` is a comma-separated list of hostnames or IP addresses on

manifests/database/postgresql_ssl_rules.pp

@@ -1,4 +1,4 @@
-# manage the pg_ident.conf and pg_hba.conf files
+# @summary manage the pg_ident.conf and pg_hba.conf files
 #
 # @api private
 define puppetdb::database::postgresql_ssl_rules (

manifests/database/read_grant.pp

@@ -1,4 +1,4 @@
-# grant read-only permissions to $database_read_only_username for all objects in $schema of $database_name
+# @summary grant read-only permissions to $database_read_only_username for all objects in $schema of $database_name
 #
 # @api private
 define puppetdb::database::read_grant (

manifests/database/read_only_user.pp

@@ -1,4 +1,5 @@
-# A define type to manage the creation of a read-only postgres users.
+# @summary manage the creation of a read-only postgres users
+#
 # In particular, it manages the necessary grants to enable such a user
 # to have read-only access to any existing objects as well as changes
 # the default access privileges so read-only access is maintained when

manifests/database/ssl_configuration.pp

@@ -1,4 +1,4 @@
-# configure SSL for the PuppetDB postgresql database
+# @summary configure SSL for the PuppetDB postgresql database
 #
 # @api private
 class puppetdb::database::ssl_configuration (

manifests/globals.pp

@@ -1,4 +1,4 @@
-# global configuration class for PuppetDB
+# @summary global configuration class for PuppetDB
 #
 # @param version
 #   The version of the `puppetdb` package that should be installed. You may specify

manifests/init.pp

@@ -1,4 +1,4 @@
-# manage PuppetDB
+# @summary manage PuppetDB
 #
 # @param listen_address
 #   The address that the web server should bind to for HTTP requests. Defaults to

manifests/master/config.pp

@@ -1,4 +1,4 @@
-# manage the puppet configuration on the primary
+# @summary manage the puppet configuration on the primary
 #
 # @param puppetdb_server
 #   The dns name or ip of the PuppetDB server. Defaults to the hostname of the

manifests/master/puppetdb_conf.pp

@@ -1,4 +1,4 @@
-# manage the puppetdb.conf file on the puppet primary
+# @summary manage the puppetdb.conf file on the puppet primary
 #
 # @api private
 class puppetdb::master::puppetdb_conf (

manifests/master/report_processor.pp

@@ -1,4 +1,4 @@
-# manage the installation of the report processor on the primary
+# @summary manage the installation of the report processor on the primary
 #
 # @api private
 class puppetdb::master::report_processor (

manifests/master/routes.pp

@@ -1,4 +1,4 @@
-# manages the routes configuration file on the master
+# @summary manages the routes configuration file on the master
 #
 # @api private
 class puppetdb::master::routes (

manifests/master/storeconfigs.pp

@@ -1,5 +1,4 @@
-# configure the puppet master to enable storeconfigs and to use puppetdb as
-# the storeconfigs backend
+# @summary configure the puppet master to enable storeconfigs and to use puppetdb as the storeconfigs backend
 #
 # @api private
 class puppetdb::master::storeconfigs (

manifests/params.pp

@@ -1,4 +1,4 @@
-# default configuration settings
+# @summary default configuration settings
 #
 # @api private
 class puppetdb::params inherits puppetdb::globals {

manifests/server.pp

@@ -1,4 +1,4 @@
-# manage the PuppetDB server
+# @summary manage the PuppetDB server
 #
 # @param listen_address
 #   The address that the web server should bind to for HTTP requests. Defaults to

manifests/server/command_processing.pp

@@ -1,4 +1,4 @@
-# manage puppetdb config ini
+# @summary manage puppetdb config ini
 #
 # @api private
 class puppetdb::server::command_processing (

manifests/server/database.pp

@@ -1,4 +1,4 @@
-# manage puppetdb database ini
+# @summary manage puppetdb database ini
 #
 # @api private
 class puppetdb::server::database (

manifests/server/firewall.pp

@@ -1,4 +1,4 @@
-# manage puppetdb firewall rules
+# @summary manage puppetdb firewall rules
 #
 # @api private
 class puppetdb::server::firewall (

manifests/server/global.pp

@@ -1,4 +1,4 @@
-# manage puppetdb global setting
+# @summary manage puppetdb global setting
 #
 # @api private
 class puppetdb::server::global (

manifests/server/jetty.pp

@@ -1,4 +1,4 @@
-# configures puppetdb jetty ini
+# @summary configures puppetdb jetty ini
 #
 # @api private
 class puppetdb::server::jetty (

manifests/server/puppetdb.pp

@@ -1,4 +1,4 @@
-# manage puppetdb ini
+# @summary manage puppetdb ini
 #
 # @api private
 class puppetdb::server::puppetdb (

manifests/server/read_database.pp

@@ -1,4 +1,4 @@
-# manage puppetdb read_database ini
+# @summary manage puppetdb read_database ini
 #
 # @api private
 class puppetdb::server::read_database (

manifests/server/validate_db.pp

@@ -1,4 +1,4 @@
-# validates the database connection
+# @summary validates the database connection
 #
 # @api private
 class puppetdb::server::validate_db (

manifests/server/validate_read_db.pp

@@ -1,4 +1,4 @@
-# validates the read only database connection
+# @summary validates the read only database connection
 #
 # @api private
 class puppetdb::server::validate_read_db (