clean up documents

9 files changed, 177 insertions, 20 deletions

diff --git a/Makefile b/Makefile
index 892bf721..a8e9c0e1 100644
--- a/Makefile
+++ b/Makefile
@@ -18,6 +18,7 @@ doc: html
 
 html:
 	@ (cd fml/lib/;make html)
+	@ (cd fml/libexec/;make html)
 	@ (cd fml/etc/;make html)
 	@ (cd cpan/dist/;make html)
 	@ $(CONV) 00_README.ja.txt > fml/doc/install.ja.html
diff --git a/fml/lib/FML/Process/Configure.pm b/fml/lib/FML/Process/Configure.pm
index 641caef3..5f55773f 100644
--- a/fml/lib/FML/Process/Configure.pm
+++ b/fml/lib/FML/Process/Configure.pm
@@ -17,10 +17,26 @@ use FML::Process::Kernel;
 use FML::Log qw(Log);
 use FML::Config;
 
+
+=head1 NAME
+
+FML::Process::Configure -- fmlconf and makefml
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+=cut
+
+
 require Exporter;
 @ISA = qw(FML::Process::Kernel Exporter);
 
 
+# Descriptions: 
+#    Arguments: $self $args
+# Side Effects: 
+# Return Value: none
 sub new
 {
     my ($self, $args) = @_;
@@ -30,13 +46,17 @@ sub new
 }
 
 
-# dummy
-sub prepare
-{
-    ;
-}
+# Descriptions: dummy yet now
+#    Arguments: $self $args
+# Side Effects: 
+# Return Value: none
+sub prepare {    ; }
 
 
+# Descriptions: 
+#    Arguments: $self $args
+# Side Effects: 
+# Return Value: none
 sub run
 {
     my ($curproc, $args) = @_;
@@ -64,6 +84,10 @@ sub run
 }
 
 
+# Descriptions: 
+#    Arguments: $self $args
+# Side Effects: 
+# Return Value: none
 sub _show_conf
 {
     my ($curproc, $args) = @_;    
@@ -82,14 +106,23 @@ sub AUTOLOAD
 }
 
 
-=head1 NAME
+=head1 AUTHOR
 
-Configure -- fmlconf and makefml
+Ken'ichi Fukamachi
 
-=head1 SYNOPSIS
+=head1 COPYRIGHT
 
-=head1 DESCRIPTION
+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::Process::Configure appeared in fml5 mailing list driver package.
+See C<http://www.fml.org/> for more details.
 
 =cut
 
+
 1;
diff --git a/fml/lib/FML/Ticket/Model/toymodel.pm b/fml/lib/FML/Ticket/Model/toymodel.pm
index cd2aaa32..ebbc9f8e 100644
--- a/fml/lib/FML/Ticket/Model/toymodel.pm
+++ b/fml/lib/FML/Ticket/Model/toymodel.pm
@@ -27,7 +27,7 @@ FML::Ticket::Model::toymodel - a toymodel of ticket systems
 
 =head1 DESCRIPTION
 
-=head1 CLASS HIERARCHY
+=head2 CLASS HIERARCHY
 
         FML::Ticket::System
                 |
diff --git a/fml/libexec/.cvsignore b/fml/libexec/.cvsignore
new file mode 100644
index 00000000..b643ba41
--- /dev/null
+++ b/fml/libexec/.cvsignore
@@ -0,0 +1 @@
+@@doc
diff --git a/fml/libexec/Makefile b/fml/libexec/Makefile
new file mode 100644
index 00000000..441df182
--- /dev/null
+++ b/fml/libexec/Makefile
@@ -0,0 +1,15 @@
+all: anal
+
+anal:
+	@ find . | sort | grep -v CVS | sed 's@./@@'
+
+html:	_clean index.ja.html
+
+index.ja.html: *.pm
+	../../doc/bin/dir2url.pl > index.ja.html
+
+_clean:
+	rm -f index.ja.html */index.ja.html
+
+clean:
+	(cd ../..;make clean)
diff --git a/fml/libexec/Standalone.pm b/fml/libexec/Standalone.pm
index 069e7e3a..e88327b0 100644
--- a/fml/libexec/Standalone.pm
+++ b/fml/libexec/Standalone.pm
@@ -14,6 +14,46 @@ package Standalone;
 use strict;
 use Carp;
 
+=head1 NAME
+
+Standalone - minimal parser for libexec/* programs
+
+=head1 SYNOPSIS
+
+   use Standalone;
+   my $main_cf = Standalone::load_cf($main_cf_file, $params);
+
+where $param is optional and the format of it is
+
+  $params = "key1=value1 key2=value2";
+
+=head1 DESCRIPTION
+
+C<load_cf()> reads the C<key = value> style configuration file and
+return the hash. The file format is like this:
+
+   key1 = value1
+
+   key2 = value2
+          value3
+
+key2 is equivalent to 
+
+   key2 = value2 value3
+
+A set of space separeted elements is an array of values.
+
+
+=head1 METHODS
+
+=head2 C<load_cf()>
+
+load "key = value" style configuration file and build a hash.
+return the reference to the hash.
+
+=cut
+
+
 # Descriptions: load "key = value" style configuration.
 #               It is available to use the following style.
 #                    key = value1 value2
@@ -121,4 +161,25 @@ sub _parse_params
 }
 
 
+
+
+=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
+
+Standalone appeared in fml5 mailing list driver package.
+See C<http://www.fml.org/> for more details.
+
+=cut
+
+
 1;
diff --git a/fml/libexec/index.ja.html b/fml/libexec/index.ja.html
new file mode 100644
index 00000000..4dbc8e55
--- /dev/null
+++ b/fml/libexec/index.ja.html
@@ -0,0 +1,33 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<HTML>
+<HEAD>
+<TITLE>
+exec::* classes
+</TITLE>
+<META http-equiv="Content-Type"
+	content="text/html; charset=EUC-JP">
+</HEAD>
+
+<BODY BGCOLOR="#E6E6FA">
+<CENTER><EM>exec class modules</EM></CENTER>
+<HR>
+<TABLE>
+<TR>
+<TD>
+ Standalone.pm <TD>
+<A HREF="Standalone.pm">[source]</A>
+<TD>
+<A HREF="@@doc/Standalone.txt">[manual]</A>
+<TD>
+<TR>
+<TD>
+ loader <TD>
+<A HREF="loader">[source]</A>
+<TD>
+<A HREF="@@doc/loader.txt">[manual]</A>
+<TD>
+</TABLE>
+</BODY>
+</HTML>
+*** warning ***
+unknown file type boot.ja.html
diff --git a/fml/libexec/loader b/fml/libexec/loader
index bc54f920..7d572642 100755
--- a/fml/libexec/loader
+++ b/fml/libexec/loader
@@ -4,7 +4,7 @@
 # Copyright (C) 2000-2001 Ken'ichi Fukamachi
 #          All rights reserved. 
 #
-# $Id: loader,v 1.11 2001/02/17 07:39:38 fukachan Exp $ 
+# $Id: loader,v 1.12 2001/02/17 14:39:16 fukachan Exp $ 
 # $FML$
 #
 
@@ -112,3 +112,25 @@ C<--params>
     --params 'key1=value1 key2=value2 ...'
 
 =cut
+
+
+=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
+
+libexec/loader appeared in fml5 mailing list driver package.
+See C<http://www.fml.org/> for more details.
+
+=cut
+
+
+1;
diff --git a/regress/simulation/todo/doc b/regress/simulation/todo/doc
index b9e6051a..681728f2 100644
--- a/regress/simulation/todo/doc
+++ b/regress/simulation/todo/doc
@@ -1,8 +1,6 @@
 hier.ja.html
 
 
-doc/architecture.gif
-doc/architecture.html
 doc/components.ja.html
 doc/dirhier.ja.html
 doc/index.ja.html
@@ -25,9 +23,6 @@ etc/defaults/tickets.cf.ja
 etc/defaults/cgi.cf.ja
 
 
-etc/config.cf
-
-
 Dialect/Japanese/String.pm
 Dialect/Japanese/Subject.pm
 Dialect/Japanese/Utils.pm
@@ -106,7 +101,3 @@ MailingList/Utils.pm
 
 ErrorMessages/00_PARSE.ja.txt
 ErrorMessages/00_README.ja.txt
-
-
-libexec/Standalone.pm
-libexec/loader