Merge pull request #267 from alexjfisher/puppet_strings_firewalld_ser…

…vice Convert `firewalld_service` docs to puppet-strings
voxpupuli · Mar 6, 2020 · a4ef580 · a4ef580
2 parents c864726 + 6f25cbe
commit a4ef580
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 22 deletions.
diff --git a/REFERENCE.md b/REFERENCE.md
@@ -20,7 +20,7 @@
 * [`firewalld_ipset`](#firewalld_ipset): Configure IPsets in Firewalld  Example:     firewalld_ipset {'internal net':         ensure   => 'present',         type     => 'hash:net',  
 * [`firewalld_port`](#firewalld_port): Assigns a port to a specific firewalld zone. firewalld_port will autorequire the firewalld_zone specified in the zone parameter so there is n
 * [`firewalld_rich_rule`](#firewalld_rich_rule): Manages firewalld rich rules.  firewalld_rich_rules will autorequire the firewalld_zone specified in the zone parameter so there is no need t
-* [`firewalld_service`](#firewalld_service): Assigns a service to a specific firewalld zone.     firewalld_service will autorequire the firewalld_zone specified in the zone parameter and
+* [`firewalld_service`](#firewalld_service): Assigns a service to a specific firewalld zone.
 * [`firewalld_zone`](#firewalld_zone): Creates and manages firewalld zones.
 
 ## Classes
@@ -833,16 +833,22 @@ handle pruning of rules
 ### firewalld_service
 
 Assigns a service to a specific firewalld zone.
-    firewalld_service will autorequire the firewalld_zone specified in the zone parameter and the firewalld::custom_service
-specified in the service parameter, so there is no need to add dependencies for this
 
-    Example:
+`firewalld_service` will autorequire the `firewalld_zone` specified in the
+`zone` parameter and the `firewalld::custom_service` specified in the `service`
+parameter. There is no need to manually add dependencies for this.
 
-        firewalld_service {'Allow SSH in the public Zone':
-            ensure  => 'present',
-            zone    => 'public',
-            service => 'ssh',
-        }
+#### Examples
+
+##### Allowing SSH
+
+```puppet
+firewalld_service {'Allow SSH in the public Zone':
+    ensure  => present,
+    zone    => 'public',
+    service => 'ssh',
+}
+```
 
 #### Properties
 

diff --git a/lib/puppet/type/firewalld_service.rb b/lib/puppet/type/firewalld_service.rb
@@ -1,19 +1,23 @@
 require 'puppet'
 
 Puppet::Type.newtype(:firewalld_service) do
-  @doc = "Assigns a service to a specific firewalld zone.
-    firewalld_service will autorequire the firewalld_zone specified in the zone parameter and the firewalld::custom_service
-		specified in the service parameter, so there is no need to add dependencies for this
-
-    Example:
-
-        firewalld_service {'Allow SSH in the public Zone':
-            ensure  => 'present',
-            zone    => 'public',
-            service => 'ssh',
-        }
-
-  "
+  desc <<-DOC
+  @summary
+    Assigns a service to a specific firewalld zone.
+
+  Assigns a service to a specific firewalld zone.
+
+  `firewalld_service` will autorequire the `firewalld_zone` specified in the
+  `zone` parameter and the `firewalld::custom_service` specified in the `service`
+  parameter. There is no need to manually add dependencies for this.
+
+  @example Allowing SSH
+    firewalld_service {'Allow SSH in the public Zone':
+        ensure  => present,
+        zone    => 'public',
+        service => 'ssh',
+    }
+  DOC
 
   ensurable do
     newvalue(:present) do