From ba9d2ee71feabd9f2a1eda60f5fa90e25147bfac Mon Sep 17 00:00:00 2001
From: Melissa Stone <melissa@puppet.com>
Date: Fri, 20 Apr 2018 11:19:24 -0700
Subject: Add Puppet Strings documentation

---
 Gemfile                                  |  4 ++++
 lib/puppet/provider/mailalias/aliases.rb |  3 +++
 lib/puppet/type/mailalias.rb             | 10 +++++++++-
 3 files changed, 16 insertions(+), 1 deletion(-)

diff --git a/Gemfile b/Gemfile
index 8daab33..48e74c4 100644
--- a/Gemfile
+++ b/Gemfile
@@ -32,6 +32,10 @@ group :development do
   gem "puppet-module-posix-dev-r#{minor_version}",     require: false, platforms: [:ruby]
   gem "puppet-module-win-default-r#{minor_version}",   require: false, platforms: [:mswin, :mingw, :x64_mingw]
   gem "puppet-module-win-dev-r#{minor_version}",       require: false, platforms: [:mswin, :mingw, :x64_mingw]
+
+  # Puppet Strings for documentation purposes
+  gem 'puppet-strings'
+  gem 'rake'
 end
 
 group :system_tests do
diff --git a/lib/puppet/provider/mailalias/aliases.rb b/lib/puppet/provider/mailalias/aliases.rb
index 9a9fa22..c8e5e3e 100644
--- a/lib/puppet/provider/mailalias/aliases.rb
+++ b/lib/puppet/provider/mailalias/aliases.rb
@@ -6,6 +6,9 @@ Puppet::Type.type(:mailalias).provide(
   default_target: '/etc/aliases',
   filetype: :flat,
 ) do
+
+  desc 'The alias provider for mailalias.'
+
   text_line :comment, match: %r{^#}
   text_line :blank, match: %r{^\s*$}
 
diff --git a/lib/puppet/type/mailalias.rb b/lib/puppet/type/mailalias.rb
index b26cd12..fde34be 100644
--- a/lib/puppet/type/mailalias.rb
+++ b/lib/puppet/type/mailalias.rb
@@ -1,7 +1,15 @@
 # Creates an email alias in the local alias database.
 module Puppet
   Type.newtype(:mailalias) do
-    @doc = 'Creates an email alias in the local alias database.'
+    desc <<-DESC
+Creates an email alias in the local alias database.
+
+@example using mailalias to redirect mail for the ftp account to root's mailbox
+mailalias { 'ftp':
+  ensure => present,
+  recipient => 'root',
+}
+    DESC
 
     ensurable
 
-- 
cgit v1.2.3