Make parameter doc RDoc compatible

This patch fixes the parameter documentation in
generic_service, network, objectstore, params,
qpid and quota to conform with the style guide and
support autogenerating parameter documentation.

Change-Id: I43faab3c59a25bf233e985d75f906a4ba026f440

manifests/generic_service.pp

@@ -1,12 +1,12 @@
+# == Define: nova::generic_service
 #
-# This class implements basic nova services.
+# This defined type implements basic nova services.
 # It is introduced to attempt to consolidate
 # common code.
 #
 # It also allows users to specify ad-hoc services
 # as needed
 #
-#
 # This define creates a service resource with title nova-${name} and
 # conditionally creates a package resource with title nova-${name}
 #

manifests/network.pp

@@ -1,15 +1,56 @@
+# == Class: nova::network
 #
-# [private_interface] Interface used by private network.
-# [public_interface] Interface used to connect vms to public network.
-# [fixed_range] Fixed private network range.
-# [num_networks] Number of networks that fixed range network should be
-#  split into.
-# [floating_range] Range of floating ip addresses to create.
-# [enabled] Rather the network service should be enabled.
-# [network_manager] The type of network manager to use.
-# [network_config]
-# [create_networks] Rather actual nova networks should be created using
+# Manages nova-network. Note that
+# Nova-network is not receiving upstream patches any more
+# and Neutron should be used in its place
+#
+# === Parameters:
+#
+# [*private_interface*]
+#   (optional) Interface used by private network.
+#   Defaults to undef
+#
+# [*fixed_range*]
+#   (optional) Fixed private network range.
+#   Defaults to '10.0.0.0/8'
+#
+# [*public_interface*]
+#   (optional) Interface used to connect vms to public network.
+#   Defaults to undef
+#
+# [*num_networks*]
+#   (optional) Number of networks that fixed range network should be
+#   split into.
+#   Defaults to 1
+#
+# [*floating_range*]
+#   (optional) Range of floating ip addresses to create.
+#   Defaults to false
+#
+# [*enabled*]
+#   (optional) Whether the network service should be enabled.
+#   Defaults to false
+#
+# [*network_manager*]
+#   (optional) The type of network manager to use.
+#   Defaults to 'nova.network.manager.FlatDHCPManager'
+#
+# [*config_overrides*]
+#   (optional) Additional parameters to pass to the network manager class
+#   Defaults to {}
+#
+# [*create_networks*]
+#   (optional) Whether actual nova networks should be created using
 #   the fixed and floating ranges provided.
+#   Defaults to true
+#
+# [*ensure_package*]
+#   (optional) The state of the nova network package
+#   Defaults to 'present'
+#
+# [*install_service*]
+#   (optional) Whether to install and enable the service
+#   Defaults to true
 #
 class nova::network(
   $private_interface = undef,

manifests/objectstore.pp

@@ -1,3 +1,16 @@
+# == Class: nova::objectstore
+#
+# Manages the nova-objectstore service
+#
+# === Parameters:
+#
+# [*enabled*]
+#   (optional) Whether to enable the service
+#   Defaults to false
+#
+# [*ensure_package*]
+#   (optional) The package state to set
+#   Defaults to 'present'
 #
 class nova::objectstore(
   $enabled        = false,

manifests/params.pp

@@ -1,4 +1,6 @@
-# these parameters need to be accessed from several locations and
+# == Class: nova::params
+#
+# These parameters need to be accessed from several locations and
 # should be considered to be constant
 class nova::params {
 

manifests/qpid.pp

@@ -1,6 +1,28 @@
+# == Class: nova::qpid
 #
-# class for installing qpid server for nova
+# Class for installing qpid server for nova
 #
+# === Parameters:
+#
+# [*enabled*]
+#   (optional) Whether to enable the service
+#   Defaults to true
+#
+# [*user*]
+#   (optional) The user to create in qpid
+#   Defaults to 'guest'
+#
+# [*password*]
+#   (optional) The password to create for the user
+#   Defaults to 'guest'
+#
+# [*file*]
+#   (optional) Sasl file for the user
+#   Defaults to '/var/lib/qpidd/qpidd.sasldb'
+#
+# [*realm*]
+#   (optional) Realm for the user
+#   Defaults to 'OPENSTACK'
 #
 class nova::qpid(
   $enabled  = true,

manifests/quota.pp

@@ -1,4 +1,73 @@
-# class for overriding the default quota settings.
+# == Class: nova::quota
+#
+# Class for overriding the default quota settings.
+#
+# === Parameters:
+#
+# [*quota_instances*]
+#   (optional) Number of instances
+#   Defaults to 10
+#
+# [*quota_cores*]
+#   (optional) Number of cores
+#   Defaults to 20
+#
+# [*quota_ram*]
+#   (optional) Ram in MB
+#   Defaults to 51200
+#
+# [*quota_volumes*]
+#   (optional) Number of volumes
+#   Defaults to 10
+#
+# [*quota_gigabytes*]
+#   (optional) Amount of ephemeral disk storage in GB
+#   Defaults to 1000
+#
+# [*quota_floating_ips*]
+#   (optional) Number of floating IPs
+#   Defaults to 10
+#
+# [*quota_metadata_items*]
+#   (optional) Number of metadata items per instance
+#   Defaults to 128
+#
+# [*quota_max_injected_files*]
+#   (optional) Number of files that can be injected per instance
+#   Defaults to 5
+#
+# [*quota_max_injected_file_content_bytes*]
+#   (optional) Maximum size in bytes of injected files
+#   Defaults to 10240
+#
+# [*quota_max_injected_file_path_bytes*]
+#   (optional) Maximum size in bytes of injected file path
+#   Defaults to 255
+#
+# [*quota_security_groups*]
+#   (optional) Number of security groups
+#   Defaults to 10
+#
+# [*quota_security_group_rules*]
+#   (optional) Number of security group rules
+#   Defaults to 20
+#
+# [*quota_key_pairs*]
+#   (optional) Number of key pairs
+#   Defaults to 10
+#
+# [*reservation_expire*]
+#   (optional) Time until reservations expire in seconds
+#   Defaults to 86400
+#
+# [*max_age*]
+#   (optional) Number of seconds between subsequent usage refreshes
+#   Defaults to 0
+#
+# [*quota_driver*]
+#   (optional) Driver to use for quota checks
+#   Defaults to 'nova.quota.DbQuotaDriver'
+#
 class nova::quota(
   $quota_instances = 10,
   $quota_cores = 20,