Merge pull request #935 from puppetlabs/pdksync_abs

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

diff --git a/types/proxy.pp b/types/proxy.pp
index 297bf1b52e0ada604a73ce02d796030148672120..0aae3954a87521555b1ff2fe189c000494fe79e8 100644 (file)
--- a/types/proxy.pp
+++ b/types/proxy.pp
@@ -1,3 +1,20 @@
+# @summary Configures Apt to connect to a proxy server.
+# 
+# @param ensure
+#   Specifies whether the proxy should exist. Valid options: 'file', 'present', and 'absent'. Prefer 'file' over 'present'.
+#
+# @param host
+#   Specifies a proxy host to be stored in `/etc/apt/apt.conf.d/01proxy`. Valid options: a string containing a hostname.
+#
+# @param port
+#   Specifies a proxy port to be stored in `/etc/apt/apt.conf.d/01proxy`. Valid options: an integer containing a port number.
+#
+# @param https
+#   Specifies whether to enable https proxies.
+#
+# @param direct
+#   Specifies whether or not to use a `DIRECT` https proxy if http proxy is used but https is not.
+#
 type Apt::Proxy = Struct[
   {
     ensure => Optional[Enum['file', 'present', 'absent']],