update documents, comments

1 files changed, 43 insertions, 5 deletions

diff --git a/fml/lib/IO/Adapter/SQL/toymodel.pm b/fml/lib/IO/Adapter/SQL/toymodel.pm
index 1f52f135..48379336 100644
--- a/fml/lib/IO/Adapter/SQL/toymodel.pm
+++ b/fml/lib/IO/Adapter/SQL/toymodel.pm
@@ -3,7 +3,7 @@
 # Copyright (C) 2000,2001 Ken'ichi Fukamachi
 #          All rights reserved.
 #
-# $FML: toymodel.pm,v 1.4 2001/09/17 11:31:51 fukachan Exp $
+# $FML: toymodel.pm,v 1.5 2001/12/22 09:21:13 fukachan Exp $
 #
 
 
@@ -32,6 +32,11 @@ model.
 =cut
 
 
+# Descriptions: add $addr 
+#               create an SQL query and exetute it
+#    Arguments: OBJ($self) STR($addr)
+# Side Effects: update DB via SQL
+# Return Value: STR
 sub add
 {
     my ($self, $addr) = @_;
@@ -46,6 +51,11 @@ sub add
 }
 
 
+# Descriptions: delete $addr 
+#               create an SQL query and exetute it
+#    Arguments: OBJ($self) STR($addr)
+# Side Effects: update DB via SQL
+# Return Value: STR
 sub delete
 {
     my ($self, $addr) = @_;
@@ -60,6 +70,11 @@ sub delete
 }
 
 
+# Descriptions: get one entry from DBMS
+#               create an SQL query and exetute it
+#    Arguments: OBJ($self) HASH_REF($args)
+# Side Effects: update DB via SQL
+# Return Value: STR
 sub fetch_all
 {
     my ($self, $args) = @_;
@@ -71,6 +86,11 @@ sub fetch_all
 }
 
 
+# Descriptions: search, md = map dependent
+#               create an SQL query and exetute it
+#    Arguments: OBJ($self) STR($regexp) HASH_REF($args)
+# Side Effects: update DB via SQL
+# Return Value: STR or ARRAY_REF
 sub md_find
 {
     my ($self, $regexp, $args) = @_;
@@ -115,7 +135,7 @@ sub md_find
 }
 
 
-# Descriptions:
+# Descriptions: build SQL statement, (not execute but build SQL string only)
 #
 #                   $args = {
 #               	query   => 'add',
@@ -126,9 +146,9 @@ sub md_find
 #               	},
 #                   }
 #
-#    Arguments: $self $args
-# Side Effects:
-# Return Value: none
+#    Arguments: OBJ($self) HASH_REF($args)
+# Side Effects: none
+# Return Value: STR(SQL statement)
 sub _build_sql_query
 {
     my ($self, $args) = @_;
@@ -158,4 +178,22 @@ sub _build_sql_query
 }
 
 
+=head1 AUTHOR
+
+Ken'ichi Fukamchi
+
+=head1 COPYRIGHT
+
+Copyright (C) 2001 Ken'ichi Fukamchi
+
+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
+
+IO::Adapter appeared in fml5 mailing list driver package.
+See C<http://www.fml.org/> for more details.
+
+=cut
+
 1;