add description for getter / setter methods (#107370)

Signed-off-by: Sven Nierlein <sven@nierlein.de>
Original-Author: Christoph Biedl <debian.axhn@manchmal.in-ulm.de>

1 files changed, 26 insertions, 0 deletions

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>.