Some initial documentation for constructors.

Document the arguments, tersely.

diff --git a/Crypt/Monkeysphere/Keyserver.pm b/Crypt/Monkeysphere/Keyserver.pm
index c53869aadb8973e824caa6309fb93639b8f269a7..9d49bd9ea0f5948fc9be7047fd4cdcd45c1ccacd 100644 (file)
--- 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 b4703494feee27e22fa0795b04a90f7765620767..dacea6d610db3e5bef2e574825d6f1cae7257293 100644 (file)
--- 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=@_;