mark private classes; update REFERENCE.md

Author: h-haaks

REFERENCE.md

@@ -1,4 +1,7 @@
+# @summary mongodb client params
+#
 # @api private
+#
 class mongodb::client::params inherits mongodb::globals {
   $package_ensure = pick($mongodb::globals::version, 'present')
   $manage_package = pick($mongodb::globals::manage_package, $mongodb::globals::manage_package_repo, false)

manifests/client/params.pp

@@ -1,4 +1,7 @@
-# PRIVATE CLASS: do not use directly
+# @summary mongodb params
+#
+# @api private
+#
 class mongodb::params inherits mongodb::globals {
   $ensure                = true
   $dbpath                = '/var/lib/mongodb'

manifests/params.pp

@@ -1,4 +1,6 @@
-# PRIVATE CLASS: do not use directly
+# @summary Manages the mongodb repository
+#
+# @api private
 #
 # @param ensure 
 # @param version

manifests/repo.pp

@@ -1,4 +1,6 @@
-# PRIVATE CLASS: do not use directly
+# @summary This is a repo class for apt
+#
+# @api private
 class mongodb::repo::apt inherits mongodb::repo {
   # we try to follow/reproduce the instruction
   # from http://docs.mongodb.org/manual/tutorial/install-mongodb-on-ubuntu/

manifests/repo/apt.pp

@@ -1,4 +1,6 @@
-# PRIVATE CLASS: do not use directly
+# @summary This is a repo class for yum
+#
+# @api private
 class mongodb::repo::yum inherits mongodb::repo {
   # We try to follow/reproduce the instruction
   # http://docs.mongodb.org/manual/tutorial/install-mongodb-on-red-hat-centos-or-fedora-linux/

manifests/repo/yum.pp

@@ -1,4 +1,7 @@
-# PRIVATE CLASS: do not call directly
+# @summary Manages mongod config
+#
+# @api private
+#
 class mongodb::server::config {
   $ensure           = $mongodb::server::ensure
   $user             = $mongodb::server::user

manifests/server/config.pp

@@ -1,4 +1,7 @@
-# PRIVATE CLASS: do not call directly
+# @summary Manages the mongod package
+#
+# @api private
+#
 class mongodb::server::install {
   $package_ensure = $mongodb::server::package_ensure
   $package_name   = $mongodb::server::package_name

manifests/server/install.pp

@@ -1,4 +1,7 @@
-# PRIVATE CLASS: do not call directly
+# @summary Manages the mongos service
+#
+# @api private
+#
 class mongodb::server::service {
   $ensure           = $mongodb::server::service_ensure
   $service_manage   = $mongodb::server::service_manage