Module: monitoring-plugin-perl Branch: master Commit: 865f5e1e8940a9e24feb5c48075c76c6a75e6faf Author: Sven Nierlein <s...@nierlein.de> Date: Fri Oct 2 18:15:27 2015 +0200 URL: https://www.monitoring-plugins.org/repositories/monitoring-plugin-perl/commit/?id=865f5e1
add description for getter / setter methods (#107370) Signed-off-by: Sven Nierlein <s...@nierlein.de> Original-Author: Christoph Biedl <debian.a...@manchmal.in-ulm.de> --- lib/Monitoring/Plugin.pm | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/lib/Monitoring/Plugin.pm b/lib/Monitoring/Plugin.pm index b39fc7a..9b2e371 100644 --- a/lib/Monitoring/Plugin.pm +++ b/lib/Monitoring/Plugin.pm @@ -412,6 +412,32 @@ following options: =back +=head2 GETTER/SETTER + +The following internal variables can be retrieved or set by calling a +method with the respective name. Expect for C<shortname>, don't change +values unless you know what you're doing. + +Examples: + + use Data::Dumper; + print Dumper($plugin->perfdata); + $plugin->shortname('DifferentName'); + +=over + +=item shortname + +=item perfdata + +=item messages + +=item opts + +=item threshold + +=back + =head2 OPTION HANDLING METHODS C<Monitoring::Plugin> provides these methods for accessing the functionality in C<Monitoring::Plugin::Getopt>.