(docs) Add puppet strings documentation for types

ghoneycutt · Nov 16, 2023 · 2ccc1c5 · 2ccc1c5
1 parent 0966901
commit 2ccc1c5
Show file tree

Hide file tree

Showing 7 changed files with 16 additions and 2 deletions.
diff --git a/types/key/type.pp b/types/key/type.pp
@@ -1,4 +1,7 @@
+# @summary validate SSH key types
+#
 # From https://github.com/puppetlabs/puppetlabs-sshkeys_core/blob/master/lib/puppet/type/sshkey.rb v1.0.2
+#
 type Ssh::Key::Type = Enum[
   'ssh-dss',
   'ssh-ed25519',

diff --git a/types/log_level.pp b/types/log_level.pp
@@ -1,3 +1,5 @@
+# @summary validate SSH log levels
+#
 type Ssh::Log_level = Enum[
   'QUIET',
   'FATAL',

diff --git a/types/permit_root_login.pp b/types/permit_root_login.pp
@@ -1,4 +1,7 @@
+# @summary validate configuration options for permit_root_login
+#
 # 'without-password' is a deprecated alias for 'prohibit-password'
+#
 type Ssh::Permit_root_login = Enum[
   'yes',
   'prohibit-password',

diff --git a/types/ssh_config.pp b/types/ssh_config.pp
@@ -1,4 +1,5 @@
-# ssh_config configuration file parameters
+# @summary ssh_config configuration file parameters
+#
 type Ssh::Ssh_Config = Struct[
   {
     Optional['Host']                             => Stdlib::Host,

diff --git a/types/sshd_config.pp b/types/sshd_config.pp
@@ -1,4 +1,5 @@
-# sshd_config configuration file parameters
+# @summary sshd_config configuration file parameters
+#
 type Ssh::Sshd_Config = Struct[
   {
     Optional['AcceptEnv']                       => String[1],

diff --git a/types/syslog_facility.pp b/types/syslog_facility.pp
@@ -1,3 +1,5 @@
+# @summary validate syslog facilities used by SSH
+#
 type Ssh::Syslog_facility = Enum[
   'DAEMON',
   'USER',

diff --git a/types/yes_no.pp b/types/yes_no.pp
@@ -1 +1,3 @@
+# @summary validate SSH configuration that uses yes/no.
+#
 type Ssh::Yes_no = Enum['yes', 'no']