From 9f785e01c8c4896ab4f711ba00e6595a4c775bc9 Mon Sep 17 00:00:00 2001
From: Joshua Hoblitt <jhoblitt@cpan.org>
Date: Tue, 20 May 2014 16:25:30 -0700
Subject: [PATCH] remove API documentation from .pp files

Refer to the README for all parameter documentation.
---
 README.md           |  5 ++++-
 manifests/init.pp   | 27 ++-------------------------
 manifests/params.pp |  8 --------
 3 files changed, 6 insertions(+), 34 deletions(-)

diff --git a/README.md b/README.md
index ec01466..752e4cc 100644
--- a/README.md
+++ b/README.md
@@ -68,7 +68,10 @@ class { '::mdadm':
 
 ##### `force_service`
 
-`Bool`  defaults to 'false'
+`Bool`  defaults to `false`
+
+By default, the `mdadm` class will not attempt to start the `mdmonitor` service
+unless the `$::mdadm_arrays` fact lists `md` arrays.  If this parameter is set to `true` the class will always attempt to start the `mdmonitor` service.
 
 ##### `service_ensure`
 
diff --git a/manifests/init.pp b/manifests/init.pp
index 09bb853..bd6f6f2 100644
--- a/manifests/init.pp
+++ b/manifests/init.pp
@@ -1,30 +1,7 @@
 # == Class: mdadm
 #
-# simple template
-#
-# === Parameters
-#
-# All parameteres are optional.
-#
-# [*config_options*]
-#   Hash.  defaults to '{}'
-#
-# [*force_service*]
-#   Bool.  defaults to 'false'
-#
-# [*service_ensure*]
-#   String.  defaults to 'running'
-#   Valid strings are: 'running', 'stopped'
-#
-# [*service_enable*]
-#   Bool.  defaults to 'true'
-#
-# [*raid_check_options*]
-#   Hash.  defaults to '{}'
-#
-# === Examples
-#
-# include mdadm
+# Please refer to https://github.com/jhoblitt/puppet-mdadm#usage for parameter
+# documentation.
 #
 class mdadm(
   $config_options     = {},
diff --git a/manifests/params.pp b/manifests/params.pp
index 74e0d3f..e55617d 100644
--- a/manifests/params.pp
+++ b/manifests/params.pp
@@ -2,14 +2,6 @@
 #
 # This class should be considered private.
 #
-# === Authors
-#
-# Joshua Hoblitt <jhoblitt@cpan.org>
-#
-# === Copyright
-#
-# Copyright (C) 2013 Joshua Hoblitt
-#
 class mdadm::params {
   case $::osfamily {
     'redhat': {