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

[puppet-modules/puppetlabs-apt.git] / manifests / setting.pp

diff --git a/manifests/setting.pp b/manifests/setting.pp
index a7b11c48b22a4e19339f3157a959abfdb1707f49..e743a5c2de80b17202d8546d0d76f16a70535582 100644 (file)
--- a/manifests/setting.pp
+++ b/manifests/setting.pp
@@ -1,4 +1,24 @@
-# Defining apt settings
+# @summary Manages Apt configuration files.
+#
+# @see https://docs.puppetlabs.com/references/latest/type.html#file-attributes for more information on source and content parameters
+#
+# @param priority
+#   Determines the order in which Apt processes the configuration file. Files with higher priority numbers are loaded first.
+#
+# @param ensure
+#   Specifies whether the file should exist. Valid options: 'present', 'absent', and 'file'.
+#
+# @param source
+#   Required, unless `content` is set. Specifies a source file to supply the content of the configuration file. Cannot be used in combination 
+#   with `content`. Valid options: see link above for Puppet's native file type source attribute.
+#
+# @param content
+#   Required, unless `source` is set. Directly supplies content for the configuration file. Cannot be used in combination with `source`. Valid 
+#   options: see link above for Puppet's native file type content attribute.
+#
+# @param notify_update
+#   Specifies whether to trigger an `apt-get update` run.
+#
 define apt::setting (
   Variant[String, Integer, Array] $priority           = 50,
   Optional[Enum['file', 'present', 'absent']] $ensure = file,