Document internal Local::Packet::Directive class

diff --git a/gatekeeper.pl b/gatekeeper.pl
index ea473024bcd0b669f1436efd9153b9537dcb04c2..1090f1de07da3c345d193bc72bb0c0555fa5c3c6 100755 (executable)
--- a/gatekeeper.pl
+++ b/gatekeeper.pl
@@ -2193,12 +2193,35 @@ C<add_notice> method.
 
 =back
 
+=head3 Local::Packet::Directive
+
+C<Local::Packet::Directive> is the (base) class for all packets using
+directive files.  This class provides a complete implementation of packet
+objects for packets using directives but not carrying uploaded files.
+
+=cut
+
 {
   package Local::Packet::Directive;
   {our @ISA = qw(Local::Packet)}
 
   use main qw(:err :log :config :gpg);
 
+=pod
+
+Additional accessor valid immediately after packet object construction:
+
+=over
+
+=item $directive_file_name = $packet->directive_file_name
+
+Return the name of the directive file associated with PACKET.  This is
+mostly used for constructing messages.
+
+=back
+
+=cut
+
   sub directive_file_name { ((shift)->files)[0] }
 
   sub parse {