Convert documentation to puppet-strings

manifests/config.pp

@@ -1,18 +1,5 @@
-# Class: nginx::config
-#
-# This module manages NGINX bootstrap and configuration
-#
-# Parameters:
-#
-# There are no default parameters for this class.
-#
-# Actions:
-#
-# Requires:
-#
-# Sample Usage:
-#
-# This class file is not called directly
+# @summary Manage NGINX bootstrap and configuration
+# @api private
 class nginx::config {
   assert_private()
 

manifests/init.pp

@@ -1,28 +1,12 @@
-# @summary
-#   This module manages NGINX.
+# @summary Manage NGINX
 #
-# Parameters:
+# Packaged NGINX
+#   - RHEL: EPEL or custom package
+#   - Debian/Ubuntu: Default Install or custom package
+#   - SuSE: Default Install or custom package
 #
-# Actions:
-#
-# Requires:
-#  puppetlabs-stdlib - https://github.com/puppetlabs/puppetlabs-stdlib
-#
-#  Packaged NGINX
-#    - RHEL: EPEL or custom package
-#    - Debian/Ubuntu: Default Install or custom package
-#    - SuSE: Default Install or custom package
-#
-#  stdlib
-#    - puppetlabs-stdlib module >= 0.1.6
-#
-# Sample Usage:
-#
-# The module works with sensible defaults:
-#
-# node default {
+# @example Use the sensible defaults
 #   include nginx
-# }
 #
 # @param include_modules_enabled
 #   When set, nginx will include module configurations files installed in the

manifests/package.pp

@@ -1,18 +1,5 @@
-# Class: nginx::package
-#
-# This module manages NGINX package installation
-#
-# Parameters:
-#
-# There are no default parameters for this class.
-#
-# Actions:
-#
-# Requires:
-#
-# Sample Usage:
-#
-# This class file is not called directly
+# @summary Manage NGINX package installation
+# @api private
 class nginx::package {
   $package_name             = $nginx::package_name
   $package_source           = $nginx::package_source

manifests/package/debian.pp

@@ -1,18 +1,5 @@
-# Class: nginx::package::debian
-#
-# This module manages NGINX package installation on debian based systems
-#
-# Parameters:
-#
-# There are no default parameters for this class.
-#
-# Actions:
-#
-# Requires:
-#
-# Sample Usage:
-#
-# This class file is not called directly
+# @summary Manage NGINX package installation on debian based systems
+# @api private
 class nginx::package::debian {
   $package_name             = $nginx::package_name
   $package_source           = $nginx::package_source

manifests/package/redhat.pp

@@ -1,18 +1,5 @@
-# Class: nginx::package::redhat
-#
-# This module manages NGINX package installation on RedHat based systems
-#
-# Parameters:
-#
-# There are no default parameters for this class.
-#
-# Actions:
-#
-# Requires:
-#
-# Sample Usage:
-#
-# This class file is not called directly
+# @summary Manage NGINX package installation on RedHat based systems
+# @api private
 class nginx::package::redhat {
   $package_name             = $nginx::package_name
   $package_source           = $nginx::package_source

manifests/params.pp

@@ -1,8 +1,5 @@
-# Class: nginx::params
-# ====================
-#
-# nginx default settings and according to operating system
-#
+# @summary default settings and according to operating system
+# @api private
 class nginx::params {
   ### Operating System Configuration
   ## This is my hacky... no hiera system. Oh well. :)

manifests/resource/geo.pp

@@ -1,56 +1,59 @@
-# define: nginx::resource::geo
+# @summary Create a new geo mapping entry for NGINX
 #
-# This definition creates a new geo mapping entry for NGINX
+# @param networks
+#    Hash of geo lookup keys and resultant values
 #
-# Parameters:
-#   [*networks*]        - Hash of geo lookup keys and resultant values
-#   [*default*]         - Sets the resulting value if the source value fails to
-#                         match any of the variants.
-#   [*ensure*]          - Enables or disables the specified location
-#   [*ranges*]          - Indicates that lookup keys (network addresses) are
-#                         specified as ranges.
-#   [*address*]         - Nginx defaults to using $remote_addr for testing.
-#                         This allows you to override that with another variable
-#                         name (automatically prefixed with $)
-#   [*delete*]          - deletes the specified network (see: geo module docs)
-#   [*proxy_recursive*] - Changes the behavior of address acquisition when
-#                         specifying trusted proxies via 'proxies' directive
-#   [*proxies*]         - Hash of network->value mappings.
+# @param default
+#    Sets the resulting value if the source value fails to match any of the
+#    variants.
 #
-# Actions:
+# @param ensure
+#    Enables or disables the specified location
 #
-# Requires:
+# @param ranges
+#    Indicates that lookup keys (network addresses) are specified as ranges.
 #
-# Sample Usage:
+# @param address
+#    Nginx defaults to using $remote_addr for testing.  This allows you to
+#    override that with another variable name (automatically prefixed with $)
 #
-#  nginx::resource::geo { 'client_network':
-#    ensure          => present,
-#    ranges          => false,
-#    default         => extra,
-#    proxy_recursive => false,
-#    proxies         => [ '192.168.99.99' ],
-#    networks        => {
-#      '10.0.0.0/8'     => 'intra',
-#      '172.16.0.0/12'  => 'intra',
-#      '192.168.0.0/16' => 'intra',
-#    }
-#  }
+# @param delete
+#    deletes the specified network (see: geo module docs)
 #
-# Sample Hiera usage:
+# @param proxy_recursive
+#    Changes the behavior of address acquisition when specifying trusted
+#    proxies via 'proxies' directive
 #
-#  nginx::geo_mappings:
-#    client_network:
-#      ensure: present
-#      ranges: false
-#      default: 'extra'
-#      proxy_recursive: false
-#      proxies:
-#         - 192.168.99.99
-#      networks:
-#        '10.0.0.0/8': 'intra'
-#        '172.16.0.0/12': 'intra'
-#        '192.168.0.0/16': 'intra'
-
+# @param proxies
+#    Hash of network->value mappings.
+#
+# @example Puppet usage
+#   nginx::resource::geo { 'client_network':
+#     ensure          => present,
+#     ranges          => false,
+#     default         => extra,
+#     proxy_recursive => false,
+#     proxies         => [ '192.168.99.99' ],
+#     networks        => {
+#       '10.0.0.0/8'     => 'intra',
+#       '172.16.0.0/12'  => 'intra',
+#       '192.168.0.0/16' => 'intra',
+#     }
+#   }
+#
+# @example Hiera usage
+#   nginx::geo_mappings:
+#     client_network:
+#       ensure: present
+#       ranges: false
+#       default: 'extra'
+#       proxy_recursive: false
+#       proxies:
+#          - 192.168.99.99
+#       networks:
+#         '10.0.0.0/8': 'intra'
+#         '172.16.0.0/12': 'intra'
+#         '192.168.0.0/16': 'intra'
 define nginx::resource::geo (
   Hash $networks,
   Optional[String] $default           = undef,