Add puppet-lint param docs check

This ensures that all parameters are documented and includes fixes to
existing undocumented parameters or incorrectly formatted docs.

Change-Id: I14c093214e45ad3b14123e16ee8ccf309ba45978
This commit is contained in:
Clayton O'Neill 2015-02-17 16:03:46 +00:00
parent 4ce3c0558b
commit c0650b1d7b
3 changed files with 13 additions and 3 deletions

View File

@ -12,6 +12,7 @@ group :development, :test do
gem 'puppet-lint-leading_zero-check' gem 'puppet-lint-leading_zero-check'
gem 'puppet-lint-variable_contains_upcase' gem 'puppet-lint-variable_contains_upcase'
gem 'puppet-lint-numericvariable' gem 'puppet-lint-numericvariable'
gem 'puppet-lint-param-docs'
gem 'rake', '10.1.1' gem 'rake', '10.1.1'
gem 'rspec-puppet', '~> 1.0.1', :require => false gem 'rspec-puppet', '~> 1.0.1', :require => false

View File

@ -18,10 +18,10 @@
# DEFAULT/bar: # DEFAULT/bar:
# value: barValue # value: barValue
# #
# [**designate_config**] # [*designate_config*]
# (optional) Allow configuration of designate.conf configurations. # (optional) Allow configuration of designate.conf configurations.
# #
# [**api_paste_ini_config**] # [*api_paste_ini_config*]
# (optional) Allow configuration of /etc/designate/api-paste.ini configurations. # (optional) Allow configuration of /etc/designate/api-paste.ini configurations.
# #
# NOTE: The configuration MUST NOT be already handled by this module # NOTE: The configuration MUST NOT be already handled by this module

View File

@ -37,9 +37,18 @@
# [*tenant*] # [*tenant*]
# Tenant for designate user. Optional. Defaults to 'services'. # Tenant for designate user. Optional. Defaults to 'services'.
# #
# [*protocol*] # [*public_protocol*]
# Protocol for public endpoint. Optional. Defaults to 'http'. # Protocol for public endpoint. Optional. Defaults to 'http'.
# #
# [*admin_protocol*]
# Protocol for admin endpoint. Optional. Defaults to 'http'.
#
# [*internal_protocol*]
# Protocol for internal endpoint. Optional. Defaults to 'http'.
#
# [*version*]
# API version endpoint. Optional. Defaults to 'v1'.
#
class designate::keystone::auth ( class designate::keystone::auth (
$password = false, $password = false,
$email = 'designate@localhost', $email = 'designate@localhost',