(FM-7318) - Added Puppet Strings formatting to documentation

[puppet-modules/puppetlabs-apt.git] / types / auth_conf_entry.pp

diff --git a/types/auth_conf_entry.pp b/types/auth_conf_entry.pp
index 40648d1fbd019256f56ff2835773a490e6a4330d..c04627649b21cb10d17257de2a051663ba4f6f4b 100644 (file)
--- a/types/auth_conf_entry.pp
+++ b/types/auth_conf_entry.pp
@@ -1 +1,20 @@
-type Apt::Auth_conf_entry = Struct[{ machine => String[1], login => String, password => String }]
+# @summary Login configuration settings that are recorded in the file `/etc/apt/auth.conf`.
+#
+# @see https://manpages.debian.org/testing/apt/apt_auth.conf.5.en.html for more information
+#
+# @param machine
+#   Hostname of machine to connect to.
+#
+# @param login
+#   Specifies the username to connect with.
+#
+# @param password
+#   Specifies the password to connect with.
+#
+type Apt::Auth_conf_entry = Struct[
+  { 
+    machine => String[1], 
+    login => String, 
+    password => String 
+  }
+]