Bring documentation up to date

Signed-off-by: Kibahop <[email protected]>

manifests/backup.pp

@@ -1,25 +1,26 @@
 #
-# == Define: easy_ipa::backup
+# @summary Define easy_ipa::backup
 #
 # Backup FreeIPA from cron
 #
-# == Parameters
-#
-# [*title*]
+# @param title
 #   The resource title is used as part of the the name for the cronjob.
-# [*type*]
+# @param type
 #   Backup type. Either 'full' (offline) or 'data' (online).
-# [*timestamp*]
+# @param timestamp
 #   Keep the default timestamp in the backup directory. Valid values are true
 #   (default) and false. Set this to false if you have and external system (e.g.
 #   bacula) that fetches the backups periodically and handles versioning on its
 #   own.
-# [*monthday*]
-# [*weekday*]
-# [*hour*]
-# [*minute*]
-#   These are standard parameters for the cron resource
-# [*email*]
+# @param monthday
+#   Standard parameter for the cron resource.
+# @param weekday
+#   Standard parameter for the cron resource.
+# @param hour
+#   Standard parameter for the cron resource.
+# @param minute
+#   Standard parameter for the cron resource
+# @param email
 #   Email to send cron notifications to. Defaults to $::servermonitor.
 #
 define easy_ipa::backup (

manifests/config/admin_user.pp

@@ -1,4 +1,6 @@
 #
+# @summary Manage admin user
+#
 class easy_ipa::config::admin_user {
   $uid_number = $easy_ipa::idstart
   $home_dir_path = '/home/admin'

manifests/helpers/flushcache.pp

@@ -1,4 +1,6 @@
 #
+# @summary Manage cache flushing
+#
 define easy_ipa::helpers::flushcache {
   #TODO: nscd should be called on both platforms.
   if $::facts['os']['family'] == 'RedHat' {

manifests/install.pp

@@ -1,4 +1,6 @@
 #
+# @summary Manage easy_ipa install
+#
 class easy_ipa::install {
   if $easy_ipa::install_epel and $facts['os']['family'] == 'RedHat' {
     ensure_resource(

manifests/install/autofs.pp

@@ -1,4 +1,6 @@
 #
+# @summary Manage autofs
+#
 class easy_ipa::install::autofs {
   package { $easy_ipa::params::autofs_package_name:
     ensure => present,

manifests/install/client.pp

@@ -1,4 +1,6 @@
 #
+# @summary Manage ipa client
+#
 class easy_ipa::install::client {
   package { 'ipa-client':
     ensure => $easy_ipa::params::ipa_client_package_ensure,

manifests/install/server.pp

@@ -1,4 +1,6 @@
 #
+# @summary Manage IPA server install
+#
 class easy_ipa::install::server {
   package { $easy_ipa::params::ipa_server_package_name:
     ensure => present,

manifests/install/server/master.pp

@@ -1,4 +1,6 @@
 #
+# @summary Manage primary server
+#
 class easy_ipa::install::server::master {
   $server_install_cmd = "\
 /usr/sbin/ipa-server-install \

manifests/install/server/replica.pp

@@ -1,4 +1,6 @@
 #
+# @summary Manage replica install
+#
 class easy_ipa::install::server::replica {
   $replica_install_cmd = "\
 /usr/sbin/ipa-replica-install \

manifests/install/sssd.pp

@@ -1,4 +1,6 @@
 #
+# @summary Manage sssd install
+#
 class easy_ipa::install::sssd {
   package { $easy_ipa::params::sssd_package_name:
     ensure => present,

manifests/monit/server.pp

@@ -1,13 +1,11 @@
 #
-# == Class: easy_ipa::monit::server
+# @summary Manage easy_ipa::monit::server
 #
 # Monitor FreeIPA server processes using monit
 #
 # This class depends on puppetfinland-monit module
 #
-# == Parameters
-#
-# [*email*]
+# @param email
 #   Email address to send notifications to. Defaults to top-scope variable
 #   $::servermonitor.
 #

plans/update_host_keys.pp

@@ -1,7 +1,8 @@
 #
-# @summary
-#   Update host keys for a domain-joined node in FreeIPA to match real host
-#   keys. Useful when real keys and keys in IPA device account have gone
+# @summary Update host keys for a domain-joined node in FreeIPA to match real host
+#   keys.
+# 
+# Useful when real keys and keys in IPA device account have gone
 #   out of sync, e.g. due to rebuilding the server from a snapshot.
 #
 #   This gets a kerberos ticket from the IPA server first, then gathers