From 2ccc1c598d1d78e15fba0edb30e6717c8ee0d191 Mon Sep 17 00:00:00 2001
From: Garrett Honeycutt <code@garretthoneycutt.com>
Date: Thu, 16 Nov 2023 15:12:09 -0500
Subject: [PATCH] (docs) Add puppet strings documentation for types

---
 types/key/type.pp          | 3 +++
 types/log_level.pp         | 2 ++
 types/permit_root_login.pp | 3 +++
 types/ssh_config.pp        | 3 ++-
 types/sshd_config.pp       | 3 ++-
 types/syslog_facility.pp   | 2 ++
 types/yes_no.pp            | 2 ++
 7 files changed, 16 insertions(+), 2 deletions(-)

diff --git a/types/key/type.pp b/types/key/type.pp
index d8f02774..08d8de30 100644
--- 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
index 9513e507..ce16ad35 100644
--- 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
index 921eaf61..02be447f 100644
--- 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
index a19248e7..1ab466d9 100644
--- 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
index 464b0f2f..7d6242ec 100644
--- 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
index 1d5eca1b..3d2866a2 100644
--- 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
index 0d9789f8..990d785b 100644
--- 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']