From 9a58403e6cef8ee6d310d57e348696e139f0ac2b Mon Sep 17 00:00:00 2001 From: David Bremner Date: Sat, 19 Mar 2011 10:15:25 -0300 Subject: [PATCH] Some initial documentation for constructors. Document the arguments, tersely. --- Crypt/Monkeysphere/Keyserver.pm | 15 +++++++++++++++ Crypt/Monkeysphere/Validator.pm | 22 ++++++++++++++++++++++ 2 files changed, 37 insertions(+) diff --git a/Crypt/Monkeysphere/Keyserver.pm b/Crypt/Monkeysphere/Keyserver.pm index c53869a..9d49bd9 100644 --- a/Crypt/Monkeysphere/Keyserver.pm +++ b/Crypt/Monkeysphere/Keyserver.pm @@ -14,6 +14,21 @@ use Crypt::Monkeysphere::Util qw(untaint); our $default_keyserver='hkp://pool.sks-keyservers.net'; +=pod + +=head2 new + +Create a new Crypt::Monkeysphere::Keyserver instance + +Arguments + Param hash, all optional. + + keyserver => URL + gnupg => GnuPG::Interface object + + (plus arguments for Crypt::Monkeysphere::Logger::new) + +=cut sub new { my $class=shift; my %opts=@_; diff --git a/Crypt/Monkeysphere/Validator.pm b/Crypt/Monkeysphere/Validator.pm index b470349..dacea6d 100644 --- a/Crypt/Monkeysphere/Validator.pm +++ b/Crypt/Monkeysphere/Validator.pm @@ -5,6 +5,28 @@ use warnings; use parent 'Crypt::Monkeysphere::Keyserver'; +=pod + +=head2 new + +Create a new Crypt::Monkeysphere::Validator instance + +Arguments + + Param hash, all optional. + + findall => 0|1 return all suitable keys, rather than first suitable + + context => 'e-mail' | something else. + control what counts as a suitable key. + + kspolicy => 'always|never|unlessvalid' + when to fetch keys from keyserver. + + (plus arguments for Crypt::Monkeysphere::{Keyserver,Logger}::new ) + +=cut + sub new { my $class=shift; my %opts=@_; -- 2.26.2