Adding strings compatible docs

Author: nibalizer

manifests/init.pp

@@ -1,3 +1,48 @@
+# = Class: squid
+#
+# Base Squid class
+#
+# == Parameters
+#
+# [*cache_dir*]
+#   String.  Filesystem location to locate cache
+#   Default: /var/spool/squid3
+#
+# [*cache_dir_size*]
+#   Integer.  Size in MB of cache to keep
+#   Default: 5000
+#
+# [*port*]
+#   Integer.  Port for squid to listen on
+#   Default: 3128
+#
+# [*maximum_object_size*]
+#   Integer. Biggest object to cache in MB
+#   Default: 3128
+#
+# [*http_access*]
+#   Array of strings. HTTP access list rules.
+#   Default: []
+#   Example: [ 'allow localnet', 'deny mynet'  ]
+#
+# [*cache_peer*]
+#   Array of strings. Upstream caches to peer with
+#   Default: []
+#   Example: [ 'squid3.example.com' ]
+#
+# [*cache_peer_access*]
+#   Array of strings. ACL entries for cache peers
+#   Default: []
+#
+# [*never_direct*]
+#   Array of strings. Hosts to connect directly to
+#   Default: []
+#   Example: [ 'directconnect1.example.com' ]
+#
+# [*cache_only*]
+#   Boolean. Use the cache never
+#   Default: false
+#
 # Puppet module to manage the squid http proxy server
 # Source: https://github.com/pro-puppet/puppet-module-squid
 
@@ -10,7 +55,7 @@
   $cache_peer          = undef,
   $cache_peer_access   = undef,
   $never_direct        = undef,
-  $cache_only          = undef,
+  $cache_only          = false,
 ) inherits squid::params {
 
 

templates/squid.conf.erb

@@ -20,11 +20,11 @@ http_access deny !Safe_ports
 http_access deny CONNECT !SSL_ports
 http_access allow localnet
 http_access allow localhost
-<% if @http_access -%> 
-<% @http_access.each do |val| -%> 
+<% if @http_access -%>
+<% @http_access.each do |val| -%>
 http_access <%= val %>
-<% end -%> 
-<% end -%> 
+<% end -%>
+<% end -%>
 http_access deny all
 http_port <%= @port %>
 maximum_object_size <%= @maximum_object_size %> MB
@@ -41,7 +41,7 @@ refresh_all_ims on
 cache_peer <%= val %>
 <% end -%>
 <% end -%>
-<% if @cache_peer_access -%> 
+<% if @cache_peer_access -%>
 <% @cache_peer_access.each do |val| -%>
 cache_peer_access <%= val %>
 <% end -%>