diff modules/apache/manifests/mod/dir.pp @ 275:d9352a684e62

Mass update of modules to remove deprecation warnings
author IBBoard <dev@ibboard.co.uk>
date Sun, 26 Jan 2020 11:36:07 +0000
parents 675c1cc61eaf
children b8d6ada284dd
line wrap: on
line diff
--- a/modules/apache/manifests/mod/dir.pp	Sat Jan 04 11:42:45 2020 +0000
+++ b/modules/apache/manifests/mod/dir.pp	Sun Jan 26 11:36:07 2020 +0000
@@ -1,11 +1,23 @@
-# Note: this sets the global DirectoryIndex directive, it may be necessary to consider being able to modify the apache::vhost to declare DirectoryIndex statements in a vhost configuration
-# Parameters:
-# - $indexes provides a string for the DirectoryIndex directive http://httpd.apache.org/docs/current/mod/mod_dir.html#directoryindex
+# @summary
+#   Installs and configures `mod_dir`.
+# 
+# @param types
+#   Specifies the text-based content types to compress.
+#
+# @param indexes
+#   Provides a string for the DirectoryIndex directive
+# 
+# @todo
+#   This sets the global DirectoryIndex directive, so it may be necessary to consider being able to modify the apache::vhost to declare 
+#   DirectoryIndex statements in a vhost configuration
+#
+# @see https://httpd.apache.org/docs/current/mod/mod_dir.html for additional documentation.
+#
 class apache::mod::dir (
-  $dir     = 'public_html',
-  $indexes = ['index.html','index.html.var','index.cgi','index.pl','index.php','index.xhtml'],
+  $dir                   = 'public_html',
+  Array[String] $indexes = ['index.html','index.html.var','index.cgi','index.pl','index.php','index.xhtml'],
 ) {
-  validate_array($indexes)
+
   include ::apache
   ::apache::mod { 'dir': }