From: Jacob Bachmeyer <jcb@gnu.org>
Date: Sat, 16 Sep 2023 00:19:25 +0000 (-0500)
Subject: Document internal Local::Packet::Directive class
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=734a3d067e5da24660fea929399f2d0883e5900c;p=gatekeeper.git

Document internal Local::Packet::Directive class
---

diff --git a/gatekeeper.pl b/gatekeeper.pl
index ea47302..1090f1d 100755
--- 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 {