volume_group: docs cleanup

Author: kenyon

manifests/volume_group.pp

@@ -1,18 +1,27 @@
-# @param physical_volumes The list of physical volumes to be included in the volume group; 
-# this will automatically set these as dependencies, but they must be defined elsewhere using the physical_volume resource type.
-
-# @param createonly If set to true the volume group will be created if it does not exist. 
-# If the volume group does exist no action will be taken. Defaults to false. Allowed Values:
-# true
-# false
-
+# @summary Manage a volume group.
+#
+# @param physical_volumes
+#   The list of physical volumes to be included in the volume group.
+#   This will automatically set these as dependencies, but they must
+#   be defined elsewhere using the physical_volume resource type.
+#
+# @param createonly
+#   If true, the volume group will be created if it does not exist. If
+#   the volume group does exist, no action will be taken.
+#
 # @param ensure
-
-# @param logical_volumes 
-
-# @param followsymlinks If set to true all current and wanted values of the physical_volumes property will be followed to their real 
-# files on disk if they are in fact symlinks. This is useful to have Puppet determine what the actual PV device is if the property 
-# value is a symlink, like '/dev/disk/by-path/xxxx -> ../../sda'. Defaults to false.
+#   Whether this volume group should be present or absent.
+#
+# @param logical_volumes
+#   A hash of lvm::logical_volume resources to create in this volume
+#   group.
+#
+# @param followsymlinks
+#   If true, all current and wanted values of the physical_volumes
+#   property will be followed to their real files on disk if they are
+#   in fact symlinks. This is useful to have Puppet determine what the
+#   actual PV device is if the property value is a symlink, like
+#   `/dev/disk/by-path/xxxx -> ../../sda`.
 #
 define lvm::volume_group (
   Variant[Hash, Array, String] $physical_volumes,