Add Puppet Strings documentation

2 files changed, 12 insertions, 1 deletions

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