Skip to content

Commit db05102

Browse files
committed
Update summaries for private .pp files
1 parent f1f6ef4 commit db05102

File tree

9 files changed

+28
-8
lines changed

9 files changed

+28
-8
lines changed

REFERENCE.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -98,15 +98,15 @@ _Public Classes_
9898

9999
_Private Classes_
100100

101-
* `apache::confd::no_accf`:
102-
* `apache::default_confd_files`:
103-
* `apache::default_mods`:
104-
* `apache::package`:
101+
* `apache::confd::no_accf`: Manages the `no-accf.conf` file.
102+
* `apache::default_confd_files`: Helper for setting up default conf.d files.
103+
* `apache::default_mods`: Installs and congfigures default mods for Apache
104+
* `apache::package`: Installs an Apache MPM.
105105
* `apache::params`: This class manages Apache parameters
106106
* `apache::php`: This class installs PHP for Apache.
107107
* `apache::proxy`: This class enabled the proxy module for Apache.
108108
* `apache::python`: This class installs Python for Apache
109-
* `apache::service`:
109+
* `apache::service`: Installs and configures Apache service.
110110
* `apache::ssl`: This class installs Apache SSL capabilities
111111
* `apache::version`: Try to automatically detect the version by OS
112112

@@ -131,8 +131,8 @@ outside of the defaults.
131131

132132
_Private Defined types_
133133

134-
* `apache::default_mods::load`:
135-
* `apache::mpm`:
134+
* `apache::default_mods::load`: Helper used by `apache::default_mods`
135+
* `apache::mpm`: Enables the use of Apache MPMs.
136136
* `apache::peruser::multiplexer`: Checks if an Apache module has a class.
137137
* `apache::peruser::processor`: Enables the `Peruser` module for FreeBSD only.
138138
* `apache::security::rule_link`: Links the activated_rules from `apache::mod::security` to the respective CRS rules on disk.

manifests/confd/no_accf.pp

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# @summary
2+
# Manages the `no-accf.conf` file.
3+
#
14
# @api private
25
class apache::confd::no_accf {
36
# Template uses no variables

manifests/default_confd_files.pp

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# @summary
2+
# Helper for setting up default conf.d files.
3+
#
14
# @api private
25
class apache::default_confd_files (
36
$all = true,

manifests/default_mods.pp

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# @summary
2+
# Installs and congfigures default mods for Apache
3+
#
14
# @api private
25
class apache::default_mods (
36
$all = true,

manifests/default_mods/load.pp

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# @summary
2+
# Helper used by `apache::default_mods`
3+
#
14
# @api private
25
define apache::default_mods::load ($module = $title) {
36
if defined("apache::mod::${module}") {

manifests/mpm.pp

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# @summary Enables the use of Apache MPMs.
2+
#
13
# @api private
24
define apache::mpm (
35
$lib_path = $::apache::lib_path,

manifests/package.pp

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# @summary
2+
# Installs an Apache MPM.
3+
#
14
# @api private
25
class apache::package (
36
$ensure = 'present',

manifests/service.pp

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# @summary
2+
# Installs and configures Apache service.
3+
#
14
# @api private
25
class apache::service (
36
$service_name = $::apache::params::service_name,

manifests/vhost.pp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# @summary
2-
# Allows specialised cnfigurations for virtual hosts that possess requirements
2+
# Allows specialised configurations for virtual hosts that possess requirements
33
# outside of the defaults.
44
#
55
# The apache module allows a lot of flexibility in the setup and configuration of virtual hosts.

0 commit comments

Comments
 (0)