Fix missing documentation for Puppet type alias

smortex · smortex · commit b82c762ac73a · 2022-05-31T15:38:39.000-10:00
[warn]: Missing documentation for Puppet type alias 'Stdlib::Forr' at types/foo.pp:1.
diff --git a/types/compat/ip_address.pp b/types/compat/ip_address.pp
@@ -1 +1,2 @@
+# Validate an IP address
 type Stdlib::Compat::Ip_address = Variant[Stdlib::Compat::Ipv4, Stdlib::Compat::Ipv6]
diff --git a/types/compat/ipv6.pp b/types/compat/ipv6.pp
@@ -1 +1,2 @@
+# Validate an IPv6 address
 type Stdlib::Compat::Ipv6 = Pattern[/\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*$/] # lint:ignore:140chars
diff --git a/types/datasize.pp b/types/datasize.pp
@@ -1 +1,2 @@
+# Validate the size of data
 type Stdlib::Datasize = Pattern[/^\d+(?i:[kmgt]b?|b)$/]
diff --git a/types/ensure/file.pp b/types/ensure/file.pp
@@ -1 +1,2 @@
+# Validate the value of the ensure parameter for a file
 type Stdlib::Ensure::File = Enum['present', 'file', 'directory', 'link', 'absent']
diff --git a/types/ensure/file/directory.pp b/types/ensure/file/directory.pp
@@ -1 +1,2 @@
+# Validate the ensure parameter of a "directory" file resource
 type Stdlib::Ensure::File::Directory = Enum['directory', 'absent']
diff --git a/types/ensure/file/file.pp b/types/ensure/file/file.pp
@@ -1 +1,2 @@
+# Validate the ensure parameter of a "file" file resource
 type Stdlib::Ensure::File::File = Enum['file', 'absent']
diff --git a/types/ensure/file/link.pp b/types/ensure/file/link.pp
@@ -1 +1,2 @@
+# Validate the ensure parameter of a "link" file resource
 type Stdlib::Ensure::File::Link = Enum['link', 'absent']
diff --git a/types/ensure/service.pp b/types/ensure/service.pp
@@ -1 +1,2 @@
+# Validate the value of the ensure parameter of a service resource
 type Stdlib::Ensure::Service = Enum['stopped', 'running']
diff --git a/types/fqdn.pp b/types/fqdn.pp
@@ -1 +1,2 @@
+# Validate a Fully Qualified Domain Name
 type Stdlib::Fqdn = Pattern[/\A(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])\z/]
diff --git a/types/host.pp b/types/host.pp
@@ -1 +1,2 @@
+# Validate a host (FQDN or IP address)
 type Stdlib::Host = Variant[Stdlib::Fqdn, Stdlib::Compat::Ip_address]
diff --git a/types/httpstatus.pp b/types/httpstatus.pp
@@ -1 +1,2 @@
+# Validate a HTTP status code
 type Stdlib::HttpStatus = Integer[100, 599]
diff --git a/types/httpsurl.pp b/types/httpsurl.pp
@@ -1 +1,2 @@
+# Validate a HTTPS URL
 type Stdlib::HTTPSUrl = Pattern[/(?i:\Ahttps:\/\/.*\z)/]
diff --git a/types/httpurl.pp b/types/httpurl.pp
@@ -1 +1,2 @@
+# Validate a HTTP(S) URL
 type Stdlib::HTTPUrl = Pattern[/(?i:\Ahttps?:\/\/.*\z)/]
diff --git a/types/ip/address.pp b/types/ip/address.pp
@@ -1,3 +1,4 @@
+# Validate an IP address
 type Stdlib::IP::Address = Variant[
   Stdlib::IP::Address::V4,
   Stdlib::IP::Address::V6,
diff --git a/types/ip/address/nosubnet.pp b/types/ip/address/nosubnet.pp
@@ -1,3 +1,4 @@
+# Validate an IP address without subnet
 type Stdlib::IP::Address::Nosubnet = Variant[
   Stdlib::IP::Address::V4::Nosubnet,
   Stdlib::IP::Address::V6::Nosubnet,
diff --git a/types/ip/address/v4.pp b/types/ip/address/v4.pp
@@ -1,3 +1,4 @@
+# Validate an IPv4 address
 type Stdlib::IP::Address::V4 = Variant[
   Stdlib::IP::Address::V4::CIDR,
   Stdlib::IP::Address::V4::Nosubnet,
diff --git a/types/ip/address/v6.pp b/types/ip/address/v6.pp
@@ -1,3 +1,4 @@
+# Validate an IPv6 address
 type Stdlib::IP::Address::V6 = Variant[
   Stdlib::IP::Address::V6::Full,
   Stdlib::IP::Address::V6::Compressed,
diff --git a/types/ip/address/v6/compressed.pp b/types/ip/address/v6/compressed.pp
@@ -1,3 +1,4 @@
+# Validate a compressed IPv6 address
 type Stdlib::IP::Address::V6::Compressed = Pattern[
   /\A:(:|(:[[:xdigit:]]{1,4}){1,7})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/,
   /\A([[:xdigit:]]{1,4}:){1}(:|(:[[:xdigit:]]{1,4}){1,6})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/,
diff --git a/types/ip/address/v6/full.pp b/types/ip/address/v6/full.pp
@@ -1 +1,2 @@
+# Validate a full IPv6 address
 type Stdlib::IP::Address::V6::Full = Pattern[/\A[[:xdigit:]]{1,4}(:[[:xdigit:]]{1,4}){7}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/]
diff --git a/types/ip/address/v6/nosubnet.pp b/types/ip/address/v6/nosubnet.pp
@@ -1,3 +1,4 @@
+# Validate an IPv6 address without subnet
 type Stdlib::IP::Address::V6::Nosubnet = Variant[
   Stdlib::IP::Address::V6::Nosubnet::Full,
   Stdlib::IP::Address::V6::Nosubnet::Compressed,
diff --git a/types/ip/address/v6/nosubnet/compressed.pp b/types/ip/address/v6/nosubnet/compressed.pp
@@ -1,3 +1,4 @@
+# Validate compressed IPv6 address without subnet
 type Stdlib::IP::Address::V6::Nosubnet::Compressed = Pattern[
   /\A:(:|(:[[:xdigit:]]{1,4}){1,7})\z/,
   /\A([[:xdigit:]]{1,4}:){1}(:|(:[[:xdigit:]]{1,4}){1,6})\z/,
diff --git a/types/ip/address/v6/nosubnet/full.pp b/types/ip/address/v6/nosubnet/full.pp
@@ -1 +1,2 @@
+# Validate full IPv6 address without subnet
 type Stdlib::IP::Address::V6::Nosubnet::Full = Pattern[/\A[[:xdigit:]]{1,4}(:[[:xdigit:]]{1,4}){7}\z/]
diff --git a/types/objectstore.pp b/types/objectstore.pp
@@ -1,3 +1,4 @@
+# Validate an ObjectStore
 type Stdlib::ObjectStore = Variant[
   Stdlib::ObjectStore::GSUri,
   Stdlib::ObjectStore::S3Uri,
diff --git a/types/objectstore/gsuri.pp b/types/objectstore/gsuri.pp
@@ -1 +1,2 @@
+# Validate a Google Cloud object store URI
 type Stdlib::ObjectStore::GSUri = Pattern[/\Ags:\/\/.*\z/]
diff --git a/types/objectstore/s3uri.pp b/types/objectstore/s3uri.pp
@@ -1 +1,2 @@
+# Validate an Amazon Web Services S3 object store URI
 type Stdlib::ObjectStore::S3Uri = Pattern[/\As3:\/\/.*\z/]
diff --git a/types/port.pp b/types/port.pp
@@ -1 +1,2 @@
+# Validate a port number
 type Stdlib::Port = Integer[0, 65535]
diff --git a/types/port/dynamic.pp b/types/port/dynamic.pp
@@ -1 +1,2 @@
+# Validate a dynamic port number
 type Stdlib::Port::Dynamic = Integer[49152, 65535]
diff --git a/types/port/ephemeral.pp b/types/port/ephemeral.pp
@@ -1 +1,2 @@
+# Validate an ephemeral port number
 type Stdlib::Port::Ephemeral = Stdlib::Port::Dynamic
diff --git a/types/port/privileged.pp b/types/port/privileged.pp
@@ -1 +1,2 @@
+# Validate a priviliged port number
 type Stdlib::Port::Privileged = Integer[1, 1023]
diff --git a/types/port/registered.pp b/types/port/registered.pp
@@ -1 +1,2 @@
+# Validate a registered port number
 type Stdlib::Port::Registered = Stdlib::Port::User
diff --git a/types/port/unprivileged.pp b/types/port/unprivileged.pp
@@ -1 +1,2 @@
+# Validate an unprivileged port number
 type Stdlib::Port::Unprivileged = Integer[1024, 65535]
diff --git a/types/port/user.pp b/types/port/user.pp
@@ -1 +1,2 @@
+# Validate a port number usable by a user
 type Stdlib::Port::User = Integer[1024, 49151]
diff --git a/types/syslogfacility.pp b/types/syslogfacility.pp
@@ -1,3 +1,4 @@
+# Validate a syslog facility
 type Stdlib::Syslogfacility = Enum[
   'kern',
   'user',
diff --git a/types/windowspath.pp b/types/windowspath.pp
@@ -1 +1,2 @@
+# Validate a Windows path
 type Stdlib::Windowspath = Pattern[/\A(([a-zA-Z]:[\\\/])|([\\\/][\\\/][^\\\/]+[\\\/][^\\\/]+)|([\\\/][\\\/]\?[\\\/][^\\\/]+)).*\z/]
diff --git a/types/yes_no.pp b/types/yes_no.pp
@@ -1 +1,2 @@
+# Validate a yes / no value
 type Stdlib::Yes_no = Pattern[/\A(?i:(yes|no))\z/]

Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
	`1`	`+# Validate an IP address`
`1`	`2`	`type Stdlib::Compat::Ip_address = Variant[Stdlib::Compat::Ipv4, Stdlib::Compat::Ipv6]`
Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
	`1`	`+# Validate an IPv6 address`
`1`	`2`	type Stdlib::Compat::Ipv6 = Pattern[/\s((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}\|:))\|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}\|((25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)(\.(25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)){3})\|:))\|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})\|:((25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)(\.(25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)){3})\|:))\|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})\|((:[0-9A-Fa-f]{1,4})?:((25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)(\.(25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)){3}))\|:))\|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})\|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)(\.(25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)){3}))\|:))\|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})\|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)(\.(25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)){3}))\|:))\|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})\|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)(\.(25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)){3}))\|:))\|(:(((:[0-9A-Fa-f]{1,4}){1,7})\|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)(\.(25[0-5]\|2[0-4]\d\|1\d\d\|[1-9]?\d)){3}))\|:)))(%.+)?\s$/] # lint:ignore:140chars
Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
	`1`	`+# Validate the size of data`
`1`	`2`	`type Stdlib::Datasize = Pattern[/^\d+(?i:[kmgt]b?\|b)$/]`
Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
	`1`	`+# Validate the value of the ensure parameter for a file`
`1`	`2`	`type Stdlib::Ensure::File = Enum['present', 'file', 'directory', 'link', 'absent']`
Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
	`1`	`+# Validate the ensure parameter of a "directory" file resource`
`1`	`2`	`type Stdlib::Ensure::File::Directory = Enum['directory', 'absent']`
Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
	`1`	`+# Validate the ensure parameter of a "file" file resource`
`1`	`2`	`type Stdlib::Ensure::File::File = Enum['file', 'absent']`
Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
	`1`	`+# Validate the ensure parameter of a "link" file resource`
`1`	`2`	`type Stdlib::Ensure::File::Link = Enum['link', 'absent']`
Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
	`1`	`+# Validate the value of the ensure parameter of a service resource`
`1`	`2`	`type Stdlib::Ensure::Service = Enum['stopped', 'running']`
Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
	`1`	`+# Validate a Fully Qualified Domain Name`
`1`	`2`	`type Stdlib::Fqdn = Pattern[/\A(([a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9\-][a-zA-Z0-9])\.)([A-Za-z0-9]\|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])\z/]`
Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
	`1`	`+# Validate a host (FQDN or IP address)`
`1`	`2`	`type Stdlib::Host = Variant[Stdlib::Fqdn, Stdlib::Compat::Ip_address]`