Puppet Strings

Author: Daniel Carabas

REFERENCE.md

@@ -1,4 +1,18 @@
-# Install client cli tool. See README.md for more details.
+# @summary Install client cli tool. 
+#
+# @param file_ensure
+#   Enum['file','absent'].
+# 
+# @param validcon_script_path
+#   Optional. Absolute path for the postgresql connection validation script.
+#
+# @param package_name
+#   String. Client package name.
+#
+# @param package_ensure
+#   String. Defaults to 'present'.
+#
+#
 class postgresql::client (
   Enum['file', 'absent'] $file_ensure        = 'file',
   Stdlib::Absolutepath $validcon_script_path = $postgresql::params::validcon_script_path,

manifests/client.pp

@@ -1,5 +1,65 @@
-# Class for setting cross-class global overrides. See README.md for more
-# details.
+# @summary Class for setting cross-class global overrides.
+#
+# @param client_package_name      
+# @param server_package_name      
+# @param contrib_package_name     
+# @param devel_package_name       
+# @param java_package_name        
+# @param docs_package_name        
+# @param perl_package_name        
+# @param plperl_package_name      
+# @param plpython_package_name    
+# @param python_package_name      
+# @param postgis_package_name     
+#
+# @param service_name             
+# @param service_provider         
+# @param service_status           
+# @param default_database         
+#
+# @param validcon_script_path     
+#
+# @param initdb_path              
+# @param createdb_path            
+# @param psql_path                
+# @param pg_hba_conf_path         
+# @param pg_ident_conf_path       
+# @param postgresql_conf_path     
+# @param recovery_conf_path       
+# @param default_connect_settings
+#
+# @param pg_hba_conf_defaults     
+#
+# @param datadir                  
+# @param confdir                  
+# @param bindir                   
+# @param xlogdir                  
+# @param logdir                   
+# @param log_line_prefix          
+#
+# @param user                     
+# @param group                    
+#
+# @param version                  
+# @param postgis_version          
+# @param repo_proxy               
+# @param repo_baseurl             
+#
+# @param needs_initdb             
+#
+# @param encoding                 
+# @param locale                   
+# @param data_checksums           
+# @param timezone                 
+#
+# @param manage_pg_hba_conf       
+# @param manage_pg_ident_conf     
+# @param manage_recovery_conf     
+#
+# @param manage_package_repo      
+# @param module_workdir           
+#
+#
 class postgresql::globals (
   $client_package_name      = undef,
   $server_package_name      = undef,

manifests/globals.pp

@@ -1,5 +1,13 @@
-# This class installs postgresql development libraries. See README.md for more
-# details.
+# @summary This class installs postgresql development libraries. 
+#
+# @param package_name
+#   String.
+# @param package_ensure
+#   String. Defaults to 'present'.
+# @param link_pg_config
+#   Boolean. 
+#
+#
 class postgresql::lib::devel(
   String $package_name      = $postgresql::params::devel_package_name,
   String[1] $package_ensure = 'present',

manifests/lib/devel.pp

@@ -1,5 +1,11 @@
-# This class installs the postgresql-docs See README.md for more
-# details.
+# @summary This class installs the postgresql-docs
+#
+# @param package_name
+#   String.
+# @param package_ensure
+#   String. Defaults to 'present'.
+# 
+#
 class postgresql::lib::docs (
   String $package_name      = $postgresql::params::docs_package_name,
   String[1] $package_ensure = 'present',

manifests/lib/docs.pp

@@ -1,5 +1,10 @@
-# This class installs the postgresql jdbc connector. See README.md for more
-# details.
+# @summary This class installs the postgresql jdbc connector.
+#
+# @param package_name
+#  String.
+# @param package_ensure
+#  String. Defaults to 'present'.
+#
 class postgresql::lib::java (
   String $package_name      = $postgresql::params::java_package_name,
   String[1] $package_ensure = 'present'

manifests/lib/java.pp

@@ -1,5 +1,10 @@
-# This class installs the perl libs for postgresql. See README.md for more
-# details.
+# @summary This class installs the perl libs for postgresql.
+#
+# @param package_name
+#   String.
+# @param package_ensure
+#   String. Defaults to 'present'.
+#
 class postgresql::lib::perl(
   String $package_name      = $postgresql::params::perl_package_name,
   String[1] $package_ensure = 'present'

manifests/lib/perl.pp

@@ -1,5 +1,10 @@
-# This class installs the python libs for postgresql. See README.md for more
-# details.
+# @summary This class installs the python libs for postgresql.
+#
+# @param package_name
+#  String.
+# @param package_ensure
+#  String. Defaults to 'present'.
+#
 class postgresql::lib::python(
   String[1] $package_name   = $postgresql::params::python_package_name,
   String[1] $package_ensure = 'present'

manifests/lib/python.pp

@@ -1,4 +1,4 @@
-# PRIVATE CLASS: do not use directly
+# @api private
 class postgresql::params inherits postgresql::globals {
   $version                    = $postgresql::globals::globals_version
   $postgis_version            = $postgresql::globals::globals_postgis_version

manifests/params.pp

@@ -1,4 +1,4 @@
-# PRIVATE CLASS: do not use directly
+# @api private
 class postgresql::repo (
   $version = undef,
   $proxy = undef,