remove all in class/define parameter docs

Replace with URLs to section anchors in README
amine2z · Jun 1, 2014 · e12054a · e12054a
1 parent b81f8fa
commit e12054a
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 103 deletions.
diff --git a/manifests/config.pp b/manifests/config.pp
@@ -2,24 +2,6 @@
 #
 # This define should be considered private.
 #
-# Note that selenium::params && selnenium::install must be included in the
-# manifest before this define may be used.
-#
-# === Parameters
-#
-# Accepts no parameters.
-#
-#
-# === Examples
-#
-#    selenium::config{ 'seleniumstandalone': }
-#
-#
-# === Authors
-#
-# Joshua Hoblitt <jhoblitt@cpan.org>
-#
-#
 define selenium::config(
   $display      = $selenium::params::display,
   $user         = $selenium::params::user,

diff --git a/manifests/hub.pp b/manifests/hub.pp
@@ -1,28 +1,7 @@
 # == Class: selenium::hub
 #
-# === Parameters
-#
-# Note that by default `selenium::server` and `selenium::hub` will try to
-# listen on the same TCP port (`4444`) and only one of them will be able to
-# function.
-#
-# ```puppet
-# # defaults
-# class { 'selenium::hub':
-#   options => '-role hub',
-# }
-# ```
-#
-# #### `options`
-#
-# `String` defaults to: `-role hub`
-#
-# Options passed to Selenium Server Hub at startup.
-#
-#
-# === Authors
-#
-# Joshua Hoblitt <jhoblitt@cpan.org>
+# Please refer to https://github.com/jhoblitt/puppet-selenium#seleniumhub for
+# parameter documentation.
 #
 #
 class selenium::hub(

diff --git a/manifests/init.pp b/manifests/init.pp
@@ -1,8 +1,9 @@
 # == Class: selenium
 #
-# Please refer to https://github.com/jhoblitt/puppet-selenium#usage for
+# Please refer to https://github.com/jhoblitt/puppet-selenium#selenium for
 # parameter documentation.
 #
+#
 class selenium(
   $user             = $selenium::params::user,
   $group            = $selenium::params::group,

diff --git a/manifests/node.pp b/manifests/node.pp
@@ -1,39 +1,7 @@
 # == Class: selenium::node
 #
-# === Parameters
-#
-# ```puppet
-# # defaults
-# class { 'selenium::node':
-#   display => ':0',
-#   options => '-Dwebdriver.enable.native.events=1 -role node',
-#   hub     => 'http://localhost:4444/grid/register',
-# }
-# ```
-#
-# #### `display`
-#
-# `String` defaults to: `:0`
-#
-# The name of the `X` display to render too.  This is set as an environment
-# variable passed to Selenium Server
-#
-# #### `options`
-#
-# `String` defaults to: `-Dwebdriver.enable.native.events=1 -role node`
-#
-# Options passed to Selenium Server Node at startup.
-#
-# #### `hub`
-#
-# `String` defaults to: `http://localhost:4444/grid/register`
-#
-# The URL of the Selenium Server Hub to connect to.
-#
-#
-# === Authors
-#
-# Joshua Hoblitt <jhoblitt@cpan.org>
+# Please refer to https://github.com/jhoblitt/puppet-selenium#seleniumnode for
+# parameter documentation.
 #
 #
 class selenium::node(

diff --git a/manifests/server.pp b/manifests/server.pp
@@ -1,32 +1,7 @@
 # == Class: selenium::server
 #
-# === Parameters
-#
-# ```puppet
-# # defaults
-# class { 'selenium::server':
-#   display => ':0',
-#   options => '-Dwebdriver.enable.native.events=1',
-# }
-# ```
-#
-# #### `display`
-#
-# `String` defaults to: `:0`
-#
-# The name of the `X` display to render too.  This is set as an environment
-# variable passed to Selenium Server
-#
-# #### `options`
-#
-# `String` defaults to: `-Dwebdriver.enable.native.events=1`
-#
-# Options passed to Selenium Server at startup.
-#
-#
-# === Authors
-#
-# Joshua Hoblitt <jhoblitt@cpan.org>
+# Please refer to https://github.com/jhoblitt/puppet-selenium#seleniumserver
+# for parameter documentation.
 #
 #
 class selenium::server(