Merge pull request #1635 from voxpupuli/fix-strings

Add blank or basic documentation to pass tests

Author: bastelfreak

REFERENCE.md

@@ -33,26 +33,26 @@
 
 ### Data types
 
-* [`Nginx::DebugConnection`](#Nginx--DebugConnection)
-* [`Nginx::ErrorLogSeverity`](#Nginx--ErrorLogSeverity)
+* [`Nginx::DebugConnection`](#Nginx--DebugConnection): Type Alias for Nginx::DebugConnection
+* [`Nginx::ErrorLogSeverity`](#Nginx--ErrorLogSeverity): Type Alias for Nginx::ErrorLogSeverity
 * [`Nginx::GzipProxied`](#Nginx--GzipProxied): custom type for gzip_proxied
-* [`Nginx::LogFormat`](#Nginx--LogFormat)
+* [`Nginx::LogFormat`](#Nginx--LogFormat): Type Alias for Nginx::LogFormat
 * [`Nginx::Package_source`](#Nginx--Package_source): Where to download NGINX from  There are three versions of NGINX available: * stable (`nginx` or `nginx-stable`); * mainline (`nginx-mainline`
-* [`Nginx::Size`](#Nginx--Size)
+* [`Nginx::Size`](#Nginx--Size): Type Alias for Nginx::Size
 * [`Nginx::StringMappings`](#Nginx--StringMappings): custom type for the `map` variable mapping
-* [`Nginx::Time`](#Nginx--Time)
-* [`Nginx::UpstreamCustomParameters`](#Nginx--UpstreamCustomParameters)
-* [`Nginx::UpstreamDefaults`](#Nginx--UpstreamDefaults)
-* [`Nginx::UpstreamLeastTime`](#Nginx--UpstreamLeastTime)
-* [`Nginx::UpstreamLeastTimeHttp`](#Nginx--UpstreamLeastTimeHttp)
-* [`Nginx::UpstreamLeastTimeStream`](#Nginx--UpstreamLeastTimeStream)
-* [`Nginx::UpstreamMember`](#Nginx--UpstreamMember)
-* [`Nginx::UpstreamMemberDefaults`](#Nginx--UpstreamMemberDefaults)
-* [`Nginx::UpstreamMemberServer`](#Nginx--UpstreamMemberServer)
-* [`Nginx::UpstreamMembers`](#Nginx--UpstreamMembers)
-* [`Nginx::UpstreamSticky`](#Nginx--UpstreamSticky)
-* [`Nginx::UpstreamStickyZone`](#Nginx--UpstreamStickyZone)
-* [`Nginx::UpstreamZone`](#Nginx--UpstreamZone)
+* [`Nginx::Time`](#Nginx--Time): Type Alias for Nginx::Time
+* [`Nginx::UpstreamCustomParameters`](#Nginx--UpstreamCustomParameters): Type Alias for Nginx::UpstreamCustomParameters
+* [`Nginx::UpstreamDefaults`](#Nginx--UpstreamDefaults): Type Alias for Nginx::UpstreamDefaults
+* [`Nginx::UpstreamLeastTime`](#Nginx--UpstreamLeastTime): Type Alias for Nginx::UpstreamLeastTime
+* [`Nginx::UpstreamLeastTimeHttp`](#Nginx--UpstreamLeastTimeHttp): Type Alias for Nginx::UpstreamLeastTimeHttp
+* [`Nginx::UpstreamLeastTimeStream`](#Nginx--UpstreamLeastTimeStream): Type Alias for Nginx::UpstreamLeastTimeStream
+* [`Nginx::UpstreamMember`](#Nginx--UpstreamMember): Type Alias for Nginx::UpstreamMember
+* [`Nginx::UpstreamMemberDefaults`](#Nginx--UpstreamMemberDefaults): Type Alias for Nginx::UpstreamMemberDefaults
+* [`Nginx::UpstreamMemberServer`](#Nginx--UpstreamMemberServer): Type Alias for Nginx::UpstreamMemberServer
+* [`Nginx::UpstreamMembers`](#Nginx--UpstreamMembers): Type Alias for Nginx::UpstreamMembers
+* [`Nginx::UpstreamSticky`](#Nginx--UpstreamSticky): Type Alias for Nginx::UpstreamSticky
+* [`Nginx::UpstreamStickyZone`](#Nginx--UpstreamStickyZone): Type Alias for Nginx::UpstreamStickyZone
+* [`Nginx::UpstreamZone`](#Nginx--UpstreamZone): Type Alias for Nginx::UpstreamZone
 
 ## Classes
 
@@ -5164,13 +5164,13 @@ Default value: `undef`
 
 ### <a name="Nginx--DebugConnection"></a>`Nginx::DebugConnection`
 
-The Nginx::DebugConnection data type.
+Type Alias for Nginx::DebugConnection
 
 Alias of `Variant[Stdlib::Host, Stdlib::IP::Address, Enum['unix:']]`
 
 ### <a name="Nginx--ErrorLogSeverity"></a>`Nginx::ErrorLogSeverity`
 
-The Nginx::ErrorLogSeverity data type.
+Type Alias for Nginx::ErrorLogSeverity
 
 Alias of `Enum['debug', 'info', 'notice', 'warn', 'error', 'crit', 'alert', 'emerg']`
 
@@ -5185,7 +5185,7 @@ Alias of `Enum['off', 'expired', 'no-cache', 'no-store', 'private', 'no_last_mod
 
 ### <a name="Nginx--LogFormat"></a>`Nginx::LogFormat`
 
-The Nginx::LogFormat data type.
+Type Alias for Nginx::LogFormat
 
 Alias of
 
@@ -5215,7 +5215,7 @@ Alias of `Enum['nginx', 'nginx-stable', 'nginx-mainline', 'passenger']`
 
 ### <a name="Nginx--Size"></a>`Nginx::Size`
 
-The Nginx::Size data type.
+Type Alias for Nginx::Size
 
 Alias of `Variant[Integer[0], Pattern[/\A\d+[k|K|m|M]?\z/]]`
 
@@ -5230,13 +5230,13 @@ Alias of `Variant[Array[Struct[{ 'key' => String[1], 'value' => String }]], Hash
 
 ### <a name="Nginx--Time"></a>`Nginx::Time`
 
-The Nginx::Time data type.
+Type Alias for Nginx::Time
 
 Alias of `Variant[Integer[0], Pattern[/^(?!$)((\d+y *)?(\d+M *)?(\d+w *)?(\d+d *)?(\d+h *)?(\d+m *)?(\d+s *)?(\d+ms)?|\d+)$/]]`
 
 ### <a name="Nginx--UpstreamCustomParameters"></a>`Nginx::UpstreamCustomParameters`
 
-The Nginx::UpstreamCustomParameters data type.
+Type Alias for Nginx::UpstreamCustomParameters
 
 Alias of
 
@@ -5267,7 +5267,7 @@ Hash[String[1], Variant[
 
 ### <a name="Nginx--UpstreamDefaults"></a>`Nginx::UpstreamDefaults`
 
-The Nginx::UpstreamDefaults data type.
+Type Alias for Nginx::UpstreamDefaults
 
 Alias of
 
@@ -5296,25 +5296,25 @@ Struct[{
 
 ### <a name="Nginx--UpstreamLeastTime"></a>`Nginx::UpstreamLeastTime`
 
-The Nginx::UpstreamLeastTime data type.
+Type Alias for Nginx::UpstreamLeastTime
 
 Alias of `Variant[Nginx::UpstreamLeastTimeHttp, Nginx::UpstreamLeastTimeStream]`
 
 ### <a name="Nginx--UpstreamLeastTimeHttp"></a>`Nginx::UpstreamLeastTimeHttp`
 
-The Nginx::UpstreamLeastTimeHttp data type.
+Type Alias for Nginx::UpstreamLeastTimeHttp
 
 Alias of `Enum['header', 'header inflight', 'last_byte', 'last_byte inflight']`
 
 ### <a name="Nginx--UpstreamLeastTimeStream"></a>`Nginx::UpstreamLeastTimeStream`
 
-The Nginx::UpstreamLeastTimeStream data type.
+Type Alias for Nginx::UpstreamLeastTimeStream
 
 Alias of `Enum['connect', 'connect inflight', 'first_byte', 'first_byte inflight', 'last_byte', 'last_byte inflight']`
 
 ### <a name="Nginx--UpstreamMember"></a>`Nginx::UpstreamMember`
 
-The Nginx::UpstreamMember data type.
+Type Alias for Nginx::UpstreamMember
 
 Alias of
 
@@ -5340,7 +5340,7 @@ Struct[{
 
 ### <a name="Nginx--UpstreamMemberDefaults"></a>`Nginx::UpstreamMemberDefaults`
 
-The Nginx::UpstreamMemberDefaults data type.
+Type Alias for Nginx::UpstreamMemberDefaults
 
 Alias of
 
@@ -5365,19 +5365,19 @@ Struct[{
 
 ### <a name="Nginx--UpstreamMemberServer"></a>`Nginx::UpstreamMemberServer`
 
-The Nginx::UpstreamMemberServer data type.
+Type Alias for Nginx::UpstreamMemberServer
 
 Alias of `Variant[Stdlib::Host, Pattern[/^unix:\/([^\/\0]+\/*)[^:]*$/]]`
 
 ### <a name="Nginx--UpstreamMembers"></a>`Nginx::UpstreamMembers`
 
-The Nginx::UpstreamMembers data type.
+Type Alias for Nginx::UpstreamMembers
 
 Alias of `Hash[String, Nginx::UpstreamMember]`
 
 ### <a name="Nginx--UpstreamSticky"></a>`Nginx::UpstreamSticky`
 
-The Nginx::UpstreamSticky data type.
+Type Alias for Nginx::UpstreamSticky
 
 Alias of
 
@@ -5410,13 +5410,13 @@ Variant[Hash[
 
 ### <a name="Nginx--UpstreamStickyZone"></a>`Nginx::UpstreamStickyZone`
 
-The Nginx::UpstreamStickyZone data type.
+Type Alias for Nginx::UpstreamStickyZone
 
 Alias of `Pattern[/^[-_\.A-Za-z0-9]*:\d+[k|K|m|M]$/]`
 
 ### <a name="Nginx--UpstreamZone"></a>`Nginx::UpstreamZone`
 
-The Nginx::UpstreamZone data type.
+Type Alias for Nginx::UpstreamZone
 
 Alias of `Pattern[/^[-_\.A-Za-z0-9]* \d+[k|K|m|M]$/]`
 

manifests/init.pp

@@ -44,6 +44,173 @@
 # @param nginx_snippets_defaults
 #   Can be used to define default values for the parameter `nginx_snippets`.
 #
+# @param client_body_temp_path
+# @param confd_only
+# @param confd_purge
+# @param conf_dir
+# @param daemon
+# @param daemon_user
+# @param daemon_group
+# @param dynamic_modules
+# @param global_owner
+# @param global_group
+# @param global_mode
+# @param limit_req_zone
+# @param log_dir
+# @param manage_log_dir
+# @param log_user
+# @param log_group
+# @param log_mode
+# @param http_access_log
+# @param http_format_log
+# @param stream_access_log
+# @param stream_custom_format_log
+# @param nginx_error_log
+# @param nginx_error_log_severity
+# @param pid
+# @param proxy_temp_path
+# @param root_group
+# @param sites_available_owner
+# @param sites_available_group
+# @param sites_available_mode
+# @param super_user
+# @param temp_dir
+# @param server_purge
+# @param conf_template
+# @param fastcgi_conf_template
+# @param uwsgi_params_template
+# @param absolute_redirect
+# @param accept_mutex
+# @param accept_mutex_delay
+# @param client_body_buffer_size
+# @param client_max_body_size
+# @param client_body_timeout
+# @param send_timeout
+# @param lingering_timeout
+# @param lingering_close
+# @param lingering_time
+# @param etag
+# @param events_use
+# @param fastcgi_cache_inactive
+# @param fastcgi_cache_key
+# @param fastcgi_cache_keys_zone
+# @param fastcgi_cache_levels
+# @param fastcgi_cache_max_size
+# @param fastcgi_cache_path
+# @param fastcgi_cache_use_stale
+# @param gzip
+# @param gzip_buffers
+# @param gzip_comp_level
+# @param gzip_disable
+# @param gzip_min_length
+# @param gzip_http_version
+# @param gzip_proxied
+# @param gzip_types
+# @param gzip_vary
+# @param gzip_static
+# @param http_cfg_prepend
+# @param http_cfg_append
+# @param http_raw_prepend
+# @param http_raw_append
+# @param http_tcp_nodelay
+# @param http_tcp_nopush
+# @param keepalive_timeout
+# @param keepalive_requests
+# @param log_format
+# @param stream_log_format
+# @param mail
+# @param map_hash_bucket_size
+# @param map_hash_max_size
+# @param mime_types_path
+# @param stream
+# @param multi_accept
+# @param names_hash_bucket_size
+# @param names_hash_max_size
+# @param nginx_cfg_prepend
+# @param proxy_buffers
+# @param proxy_buffer_size
+# @param proxy_cache_inactive
+# @param proxy_cache_keys_zone
+# @param proxy_cache_levels
+# @param proxy_cache_max_size
+# @param proxy_cache_path
+# @param proxy_cache_loader_files
+# @param proxy_cache_loader_sleep
+# @param proxy_cache_loader_threshold
+# @param proxy_use_temp_path
+# @param proxy_connect_timeout
+# @param proxy_headers_hash_bucket_size
+# @param proxy_http_version
+# @param proxy_read_timeout
+# @param proxy_redirect
+# @param proxy_send_timeout
+# @param proxy_set_header
+# @param proxy_hide_header
+# @param proxy_pass_header
+# @param proxy_ignore_header
+# @param proxy_max_temp_file_size
+# @param proxy_busy_buffers_size
+# @param sendfile
+# @param server_tokens
+# @param spdy
+# @param http2
+# @param ssl_stapling
+# @param ssl_stapling_verify
+# @param snippets_dir
+# @param manage_snippets_dir
+# @param types_hash_bucket_size
+# @param types_hash_max_size
+# @param worker_connections
+# @param ssl_prefer_server_ciphers
+# @param worker_processes
+# @param worker_rlimit_nofile
+# @param pcre_jit
+# @param ssl_protocols
+# @param ssl_ciphers
+# @param ssl_dhparam
+# @param ssl_ecdh_curve
+# @param ssl_session_cache
+# @param ssl_session_timeout
+# @param ssl_session_tickets
+# @param ssl_session_ticket_key
+# @param ssl_buffer_size
+# @param ssl_crl
+# @param ssl_stapling_file
+# @param ssl_stapling_responder
+# @param ssl_trusted_certificate
+# @param ssl_verify_depth
+# @param ssl_password_file
+# @param package_ensure
+# @param package_name
+# @param package_source
+# @param package_flavor
+# @param manage_repo
+# @param mime_types
+# @param mime_types_preserve_defaults
+# @param repo_release
+# @param passenger_package_ensure
+# @param repo_source
+# @param service_ensure
+# @param service_enable
+# @param service_flags
+# @param service_restart
+# @param service_name
+# @param service_manage
+# @param geo_mappings
+# @param geo_mappings_defaults
+# @param string_mappings
+# @param string_mappings_defaults
+# @param nginx_locations
+# @param nginx_locations_defaults
+# @param nginx_mailhosts
+# @param nginx_mailhosts_defaults
+# @param nginx_servers
+# @param nginx_servers_defaults
+# @param nginx_streamhosts
+# @param nginx_streamhosts_defaults
+# @param nginx_upstreams
+# @param nginx_upstreams_defaults
+# @param purge_passenger_repo
 class nginx (
   ### START Nginx Configuration ###
   Optional[Variant[Stdlib::Absolutepath, Tuple[Stdlib::Absolutepath, Integer, 1, 4]]] $client_body_temp_path      = undef,

types/debugconnection.pp

@@ -1 +1,2 @@
+# @summary Type Alias for Nginx::DebugConnection
 type Nginx::DebugConnection = Variant[Stdlib::Host, Stdlib::IP::Address, Enum['unix:']]

types/errorlogseverity.pp

@@ -1 +1,2 @@
+# @summary Type Alias for Nginx::ErrorLogSeverity
 type Nginx::ErrorLogSeverity = Enum['debug','info','notice','warn','error','crit','alert','emerg']

types/logformat.pp

@@ -1,3 +1,4 @@
+# @summary Type Alias for Nginx::LogFormat
 type Nginx::LogFormat = Variant[
   String[1],
   Struct[{

types/size.pp

@@ -1,3 +1,4 @@
+# @summary Type Alias for Nginx::Size
 type Nginx::Size = Variant[
   Integer[0],
   Pattern[/\A\d+[k|K|m|M]?\z/],

types/time.pp

@@ -1,3 +1,4 @@
+# @summary Type Alias for Nginx::Time
 type Nginx::Time = Variant[
   Integer[0],
   Pattern[/^(?!$)((\d+y *)?(\d+M *)?(\d+w *)?(\d+d *)?(\d+h *)?(\d+m *)?(\d+s *)?(\d+ms)?|\d+)$/],

types/upstreamcustomparameters.pp

@@ -1,3 +1,4 @@
+# @summary Type Alias for Nginx::UpstreamCustomParameters
 type Nginx::UpstreamCustomParameters = Hash[String[1],
   Variant[
     String[1],

types/upstreamdefaults.pp

@@ -1,3 +1,4 @@
+# @summary Type Alias for Nginx::UpstreamDefaults
 type Nginx::UpstreamDefaults = Struct[{
   context           => Optional[Enum['http', 'stream']],
   member_defaults   => Optional[Nginx::UpstreamMemberDefaults],

types/upstreamleasttime.pp

@@ -1 +1,2 @@
+# @summary Type Alias for Nginx::UpstreamLeastTime
 type Nginx::UpstreamLeastTime = Variant[Nginx::UpstreamLeastTimeHttp,Nginx::UpstreamLeastTimeStream]

types/upstreamleasttimehttp.pp

@@ -1 +1,2 @@
+# @summary Type Alias for Nginx::UpstreamLeastTimeHttp
 type Nginx::UpstreamLeastTimeHttp = Enum['header','header inflight','last_byte','last_byte inflight']

types/upstreamleasttimestream.pp

@@ -1 +1,2 @@
+# @summary Type Alias for Nginx::UpstreamLeastTimeStream
 type Nginx::UpstreamLeastTimeStream = Enum['connect','connect inflight','first_byte','first_byte inflight','last_byte','last_byte inflight']

types/upstreammember.pp

@@ -1,3 +1,4 @@
+# @summary Type Alias for Nginx::UpstreamMember
 type Nginx::UpstreamMember = Struct[{
   server         => Optional[Nginx::UpstreamMemberServer],
   port           => Optional[Stdlib::Port],