update comments with FNF-ify

4 files changed, 83 insertions, 22 deletions

diff --git a/fml/lib/FML/Article.pm b/fml/lib/FML/Article.pm
index ddbde54a..56579b8f 100644
--- a/fml/lib/FML/Article.pm
+++ b/fml/lib/FML/Article.pm
@@ -4,7 +4,7 @@
 #   All rights reserved. This program is free software; you can
 #   redistribute it and/or modify it under the same terms as Perl itself. 
 #
-# $FML: Article.pm,v 1.24 2001/10/27 04:11:29 fukachan Exp $
+# $FML: Article.pm,v 1.25 2001/11/18 06:40:16 fukachan Exp $
 #
 
 package FML::Article;
@@ -45,7 +45,7 @@ message $curproc->{ incoming_message }.
 
 
 # Descriptions: constructor
-#    Arguments: $self $curproc
+#    Arguments: OBJ($self) OBJ($curproc)
 # Side Effects: none
 # Return Value: FML::Article object
 sub new
@@ -62,7 +62,7 @@ sub new
 
 
 # Descriptions: prepare article template to distribute
-#    Arguments: $self $curproc
+#    Arguments: OBJ($self) OBJ($curproc)
 # Side Effects: build $curproc->{ article }
 # Return Value: none
 sub _setup_article_template
@@ -93,7 +93,7 @@ This routine uses C<File::Sequence> module.
 
 
 # Descriptions: determine article id (sequence number)
-#    Arguments: $self
+#    Arguments: OBJ($self)
 # Side Effects: record the current article sequence number
 # Return Value: number (sequence identifier)
 sub increment_id
@@ -122,7 +122,7 @@ return the current article sequence number.
 =cut
 
 # Descriptions: return the article id (sequence number)
-#    Arguments: $self
+#    Arguments: OBJ($self)
 # Side Effects: none
 # Return Value: number (sequence number)
 sub id
@@ -143,7 +143,7 @@ If the variable C<$use_spool> is 'yes', this routine works.
 
 
 # Descriptions: spool in the article
-#    Arguments: $self $curproc
+#    Arguments: OBJ($self) NUM($id)
 # Side Effects: 
 # Return Value: none
 sub spool_in
@@ -186,6 +186,11 @@ sub spool_in
 =cut
 
 
+# Descriptions: scan the spool_dir and get max number among files in it
+#               It must be the max (latest) article number in its folder.
+#    Arguments: OBJ($curproc) STR($spool_dir)
+# Side Effects: none
+# Return Value: NUM(sequence number) or undef
 sub speculate_max_id
 {
     my ($curproc, $spool_dir) = @_;
diff --git a/fml/lib/FML/Command.pm b/fml/lib/FML/Command.pm
index 45e80e35..1ee2758e 100644
--- a/fml/lib/FML/Command.pm
+++ b/fml/lib/FML/Command.pm
@@ -4,7 +4,7 @@
 #   All rights reserved. This program is free software; you can
 #   redistribute it and/or modify it under the same terms as Perl itself. 
 #
-# $FML: Command.pm,v 1.12 2001/10/17 10:24:25 fukachan Exp $
+# $FML: Command.pm,v 1.13 2001/11/08 03:37:33 fukachan Exp $
 #
 
 package FML::Command;
@@ -44,6 +44,10 @@ C<FML::Command::command>.
 =cut
 
 
+# Descriptions: ordinary constructor
+#    Arguments: OBJ($self)
+# Side Effects: none
+# Return Value: OBJ
 sub new
 {
     my ($self) = @_;
@@ -53,9 +57,17 @@ sub new
 }
 
 
+# Descriptions: ordinary destructor
+#    Arguments: none
+# Side Effects: none
+# Return Value: none
 sub DESTROY { ;}
 
 
+# Descriptions: run FML::Command::XXX:YYY()
+#    Arguments: OBJ($self) OBJ($curproc) HASH_REF($command_args)
+# Side Effects: load appropriate module
+# Return Value: none
 sub AUTOLOAD
 {
     my ($self, $curproc, $command_args) = @_;
@@ -106,6 +118,11 @@ return 1 by default (almost all command requires lock).
 
 =cut
 
+
+# Descriptions: we need lock or not
+#    Arguments: OBJ($self) STR($mode) STR($comname)
+# Side Effects: none
+# Return Value: 1 / 0 / undef
 sub require_lock
 {
     my ($self, $mode, $comname) = @_;
diff --git a/fml/lib/FML/Date.pm b/fml/lib/FML/Date.pm
index bb319867..62eb50a2 100644
--- a/fml/lib/FML/Date.pm
+++ b/fml/lib/FML/Date.pm
@@ -2,7 +2,7 @@
 #
 # Copyright (C) 2000 Ken'ichi Fukamachi
 #
-# $FML: Date.pm,v 1.9 2001/07/02 14:08:53 fukachan Exp $
+# $FML: Date.pm,v 1.10 2001/11/03 08:19:49 fukachan Exp $
 #
 
 package FML::Date;
@@ -10,4 +10,40 @@ package FML::Date;
 use Mail::Message::Date;
 @ISA = qw(Mail::Message::Date);
 
+package FML::Date;
+use strict;
+use vars qw(@ISA @EXPORT @EXPORT_OK $AUTOLOAD);
+use Carp;
+
+=head1 NAME
+
+FML::Date - date
+
+=head1 SYNOPSIS
+
+See C<Mail::Message::Date>.
+
+=head1 DESCRIPTION
+
+All requests are forwarded to C<Mail::Message::Date>.
+
+=head1 AUTHOR
+
+Ken'ichi Fukamachi
+
+=head1 COPYRIGHT
+
+Copyright (C) 2001 Ken'ichi Fukamachi
+
+All rights reserved. This program is free software; you can
+redistribute it and/or modify it under the same terms as Perl itself. 
+
+=head1 HISTORY
+
+FML::Date appeared in fml5 mailing list driver package.
+See C<http://www.fml.org/> for more details.
+
+=cut
+
+
 1;
diff --git a/fml/lib/FML/Header/Subject.pm b/fml/lib/FML/Header/Subject.pm
index 10d42d35..3aa357b2 100644
--- a/fml/lib/FML/Header/Subject.pm
+++ b/fml/lib/FML/Header/Subject.pm
@@ -4,7 +4,7 @@
 #   All rights reserved. This program is free software; you can
 #   redistribute it and/or modify it under the same terms as Perl itself. 
 #
-# $FML: Subject.pm,v 1.20 2001/10/08 23:28:27 fukachan Exp $
+# $FML: Subject.pm,v 1.21 2001/11/26 08:41:36 fukachan Exp $
 #
 
 package FML::Header::Subject;
@@ -36,9 +36,9 @@ constructor.
 
 
 # Descriptions: constructor
-#    Arguments: $self
+#    Arguments: OBJ($self)
 # Side Effects: none
-# Return Value: object
+# Return Value: OBJ
 sub new
 {
     my ($self) = @_;
@@ -56,8 +56,9 @@ replace the subject with the newer content.
 
 =cut
 
+
 # Descriptions: add or rewrite the subject tag
-#    Arguments: $self $header $config $args
+#    Arguments: OBJ($self) OBJ($header) OBJ($config) HASH_REF($args)
 # Side Effects: the header subject is rewritten
 # Return Value: none
 sub rewrite_subject_tag
@@ -86,10 +87,10 @@ sub rewrite_subject_tag
 
 
 # Descriptions: remove tag-like string
-#    Arguments: $subject $args
+#    Arguments: STR($subject) STR($tag)
 #               XXX non OO type function
 # Side Effects: none
-# Return Value: subject string
+# Return Value: STR(subject string)
 sub _delete_subject_tag
 {
     my ($subject, $tag) = @_;
@@ -108,10 +109,11 @@ build a regular expression to trap C<$string>.
 
 =cut
 
+
 # Descriptions: wrapper for _regexp_compile
-#    Arguments: $self $args
+#    Arguments: OBJ($self) STR($string)
 # Side Effects: none
-# Return Value: string (regular expression)
+# Return Value: STR(regular expression)
 sub regexp_compile
 {
     my ($self, $string) = @_;
@@ -121,10 +123,11 @@ sub regexp_compile
 
 # Descriptions: create regexp for a subject tag, for example
 #               "[%s %05d]" => "\[\S+ \d+\]"
-#    Arguments: a subject tag string
-#               XXX non OO type function
+#               not OO style.
+#    Arguments: STR($s)
+#               $s == a subject tag string
 # Side Effects: none
-# Return Value: a regexp for the given tag
+# Return Value: STR(a regexp for the given tag)
 sub _regexp_compile
 {
     my ($s) = @_;
@@ -155,7 +158,7 @@ Now we can trap Japanese specific keywords.
 
 
 # Descriptions: speculate $subject looks a reply message or not?
-#    Arguments: $self $subject
+#    Arguments: OBJ($self) STR($subject)
 # Side Effects: none
 # Return Value: 1 (looks reply message) or 0
 sub is_reply
@@ -175,9 +178,9 @@ sub is_reply
 
 
 # Descriptions: cut off reply keywords like "Re:"
-#    Arguments: $self $r_subject
+#    Arguments: OBJ($self) STR_REF($r_subject)
 #               $r_subject is SCALAR REREFENCE to the subject string
-# Side Effects: none
+# Side Effects: $r_subject is rewritten
 # Return Value: none
 sub _cut_off_reply
 {