X-Git-Url: https://review.fuel-infra.org/gitweb?a=blobdiff_plain;f=manifests%2Fconf.pp;h=0aec66dd63f69f5bb68195e4f9f6120c0c6332ae;hb=refs%2Fheads%2Fpdksync_%28MAINT%29_Pin_puppetlabs-puppet_agent;hp=b791f852190b4f5938774f1a4ae90db348a6ee39;hpb=478afa269fd05ca986cf82629eaca00a9cc27553;p=puppet-modules%2Fpuppetlabs-apt.git

diff --git a/manifests/conf.pp b/manifests/conf.pp
index b791f85..0aec66d 100644
--- a/manifests/conf.pp
+++ b/manifests/conf.pp
@@ -1,11 +1,24 @@
-# Defining apt config
+# @summary Specifies a custom Apt configuration file.
+#
+# @param content
+#   Required unless `ensure` is set to 'absent'. Directly supplies content for the configuration file.
+#
+# @param ensure
+#    Specifies whether the configuration file should exist. Valid options: 'present' and 'absent'. 
+#
+# @param priority
+#   Determines the order in which Apt processes the configuration file. Files with lower priority numbers are loaded first. 
+#   Valid options: a string containing an integer or an integer.
+#
+# @param notify_update
+#   Specifies whether to trigger an `apt-get update` run.
+#
 define apt::conf (
   Optional[String] $content          = undef,
   Enum['present', 'absent'] $ensure  = present,
   Variant[String, Integer] $priority = 50,
   Optional[Boolean] $notify_update   = undef,
 ) {
-
   unless $ensure == 'absent' {
     unless $content {
       fail('Need to pass in content parameter')