Skip to content

Commit e12054a

Browse files
author
Joshua Hoblitt
committed
remove all in class/define parameter docs
Replace with URLs to section anchors in README
1 parent b81f8fa commit e12054a

File tree

5 files changed

+8
-103
lines changed

5 files changed

+8
-103
lines changed

manifests/config.pp

-18
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,6 @@
22
#
33
# This define should be considered private.
44
#
5-
# Note that selenium::params && selnenium::install must be included in the
6-
# manifest before this define may be used.
7-
#
8-
# === Parameters
9-
#
10-
# Accepts no parameters.
11-
#
12-
#
13-
# === Examples
14-
#
15-
# selenium::config{ 'seleniumstandalone': }
16-
#
17-
#
18-
# === Authors
19-
#
20-
# Joshua Hoblitt <[email protected]>
21-
#
22-
#
235
define selenium::config(
246
$display = $selenium::params::display,
257
$user = $selenium::params::user,

manifests/hub.pp

+2-23
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,7 @@
11
# == Class: selenium::hub
22
#
3-
# === Parameters
4-
#
5-
# Note that by default `selenium::server` and `selenium::hub` will try to
6-
# listen on the same TCP port (`4444`) and only one of them will be able to
7-
# function.
8-
#
9-
# ```puppet
10-
# # defaults
11-
# class { 'selenium::hub':
12-
# options => '-role hub',
13-
# }
14-
# ```
15-
#
16-
# #### `options`
17-
#
18-
# `String` defaults to: `-role hub`
19-
#
20-
# Options passed to Selenium Server Hub at startup.
21-
#
22-
#
23-
# === Authors
24-
#
25-
# Joshua Hoblitt <[email protected]>
3+
# Please refer to https://github.com/jhoblitt/puppet-selenium#seleniumhub for
4+
# parameter documentation.
265
#
276
#
287
class selenium::hub(

manifests/init.pp

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# == Class: selenium
22
#
3-
# Please refer to https://github.com/jhoblitt/puppet-selenium#usage for
3+
# Please refer to https://github.com/jhoblitt/puppet-selenium#selenium for
44
# parameter documentation.
55
#
6+
#
67
class selenium(
78
$user = $selenium::params::user,
89
$group = $selenium::params::group,

manifests/node.pp

+2-34
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,7 @@
11
# == Class: selenium::node
22
#
3-
# === Parameters
4-
#
5-
# ```puppet
6-
# # defaults
7-
# class { 'selenium::node':
8-
# display => ':0',
9-
# options => '-Dwebdriver.enable.native.events=1 -role node',
10-
# hub => 'http://localhost:4444/grid/register',
11-
# }
12-
# ```
13-
#
14-
# #### `display`
15-
#
16-
# `String` defaults to: `:0`
17-
#
18-
# The name of the `X` display to render too. This is set as an environment
19-
# variable passed to Selenium Server
20-
#
21-
# #### `options`
22-
#
23-
# `String` defaults to: `-Dwebdriver.enable.native.events=1 -role node`
24-
#
25-
# Options passed to Selenium Server Node at startup.
26-
#
27-
# #### `hub`
28-
#
29-
# `String` defaults to: `http://localhost:4444/grid/register`
30-
#
31-
# The URL of the Selenium Server Hub to connect to.
32-
#
33-
#
34-
# === Authors
35-
#
36-
# Joshua Hoblitt <[email protected]>
3+
# Please refer to https://github.com/jhoblitt/puppet-selenium#seleniumnode for
4+
# parameter documentation.
375
#
386
#
397
class selenium::node(

manifests/server.pp

+2-27
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,7 @@
11
# == Class: selenium::server
22
#
3-
# === Parameters
4-
#
5-
# ```puppet
6-
# # defaults
7-
# class { 'selenium::server':
8-
# display => ':0',
9-
# options => '-Dwebdriver.enable.native.events=1',
10-
# }
11-
# ```
12-
#
13-
# #### `display`
14-
#
15-
# `String` defaults to: `:0`
16-
#
17-
# The name of the `X` display to render too. This is set as an environment
18-
# variable passed to Selenium Server
19-
#
20-
# #### `options`
21-
#
22-
# `String` defaults to: `-Dwebdriver.enable.native.events=1`
23-
#
24-
# Options passed to Selenium Server at startup.
25-
#
26-
#
27-
# === Authors
28-
#
29-
# Joshua Hoblitt <[email protected]>
3+
# Please refer to https://github.com/jhoblitt/puppet-selenium#seleniumserver
4+
# for parameter documentation.
305
#
316
#
327
class selenium::server(

0 commit comments

Comments
 (0)