[Ftnpl-cvs] SF.net SVN: ftnpl:[615] trunk/modules/FTN/Packet

[<ja...@us...>]

Revision: 615
          http://ftnpl.svn.sourceforge.net/ftnpl/?rev=615&view=rev
Author:   jame
Date:     2011-07-15 17:12:51 +0000 (Fri, 15 Jul 2011)

Log Message:
-----------
Renamed the functions and updated the documentation.

Renamed the readpkt as read_ftn_packet, and renamed the writepkt
function as write_ftn_packet.  Corrected the pod documentation for
the read_ftn_packet function.

Modified Paths:
--------------
    trunk/modules/FTN/Packet/Changes
    trunk/modules/FTN/Packet/README
    trunk/modules/FTN/Packet/TODO
    trunk/modules/FTN/Packet/lib/FTN/Packet.pm

Modified: trunk/modules/FTN/Packet/Changes
===================================================================
--- trunk/modules/FTN/Packet/Changes	2011-07-15 17:12:43 UTC (rev 614)
+++ trunk/modules/FTN/Packet/Changes	2011-07-15 17:12:51 UTC (rev 615)
@@ -1,5 +1,10 @@
 Revision history for Perl extension FTN::Packet
 
+0.07  Sat May 13 2006
+    - Renamed the readpkt function as read_ftn_packet, and renamed the writepkt
+      function as write_ftn_packet.
+    - Corrected the pod documentation for the read_ftn_packet function. 
+
 0.06  Sat Mar 27 2004
     - Created the lib/FTN source directory and moved Packet.pm to it.
     - Imported and created initial versions of readpkt & writepkt functions.

Modified: trunk/modules/FTN/Packet/README
===================================================================
--- trunk/modules/FTN/Packet/README	2011-07-15 17:12:43 UTC (rev 614)
+++ trunk/modules/FTN/Packet/README	2011-07-15 17:12:51 UTC (rev 615)
@@ -1,6 +1,6 @@
 FTN::Packet
 
-Copyright (c) 2001-2004 Robert James Clay.  All Rights Reserved.
+Copyright (c) 2001-2004,2006 Robert James Clay.  All Rights Reserved.
 This is free software;  you can redistribute it and/or
 mnodify it under the same terms as Perl itself.
 

Modified: trunk/modules/FTN/Packet/TODO
===================================================================
--- trunk/modules/FTN/Packet/TODO	2011-07-15 17:12:43 UTC (rev 614)
+++ trunk/modules/FTN/Packet/TODO	2011-07-15 17:12:51 UTC (rev 615)
@@ -1,6 +1,6 @@
 To do:  FTN:Packet
 
-    writepkt()
+    write_ftn_packet()
 - When doing, for instance, two messages:  the two messages are making it into
 the packets but they're both the text of the second message.
 - Also the serial number for the MSGID is coming up as the same for both.  When

Modified: trunk/modules/FTN/Packet/lib/FTN/Packet.pm
===================================================================
--- trunk/modules/FTN/Packet/lib/FTN/Packet.pm	2011-07-15 17:12:43 UTC (rev 614)
+++ trunk/modules/FTN/Packet/lib/FTN/Packet.pm	2011-07-15 17:12:51 UTC (rev 615)
@@ -9,11 +9,11 @@
 
 =head1 VERSION
 
-VERSION 0.06
+VERSION 0.07
 
 =cut
 
-$VERSION = '0.06';
+$VERSION = '0.07';
 
 =head1 DESCRIPTION
 
@@ -26,7 +26,8 @@
 
 =head1 EXPORT
 
-The following functions are available in this module:  readpkt(), writepkt().
+The following functions are available in this module:  read_ftn_packet(),
+write_ftn_packet().
 
 =cut
 
@@ -36,18 +37,19 @@
 # Do not simply export all your public functions/methods/constants.
 @EXPORT = qw(
 );
-@EXPORT_OK = qw( &readpkt(), &writepkt()
+@EXPORT_OK = qw( &read_ftn_packet(), &write_ftn_packet()
 	
 );
 
 =head1 FUNCTIONS
 
-=head2 readpkt
+=head2 read_ftn_packet
 
-Syntax:  @messages = readpkt(*PKT);
+Syntax:  $messages = read_ftn_packet(*PKT);
 
-Read a Fidonet/FTN packet.  Returns the messages in the packet as an array of
-hash references, which can be read as follows:
+Read a Fidonet/FTN packet.  Returns the messages in the packet as a reference
+to an array of hash references, which can be read as follows:
+
     $msg_ref = pop(@{$messages});
     $msg_area = ${$msg_ref}->('area');
     $msg_date = ${$msg_ref}->('ftnscdate');
@@ -65,7 +67,7 @@
 ###############################################
 # Read Messages from FTN packet 
 ###############################################
-sub readpkt {
+sub read_ftn_packet {
 
     my ($PKT) = @_;
     # "$PKT" is a file pointer to the packet file being read
@@ -225,12 +227,12 @@
     
     return (\@messages);
     
-}   # end sub readpkt
+}   # end sub read_ftn_packet
 
 
-=head2 writepkt
+=head2 write_ftn_packet
 
-Syntax:  writepkt($OutDir, \%PktInfo, \@messages);
+Syntax:  write_ftn_packet($OutDir, \%PktInfo, \@messages);
 
 Create a Fidonet/FTN packet, where:
     $OutDir is the directory where the packet is to be created
@@ -239,7 +241,7 @@
 
 =cut
 
-sub writepkt {
+sub write_ftn_packet {
 
     my ($OutDir,$PktInfo, $messages) = @_;
 
@@ -393,11 +395,11 @@
 
 =head1 ACKNOWLEDGEMENTS
 
-Code for the readpkt function was initially derived from the newmsgs subroutine
+Code for the read_ftn_packet function was initially derived from the newmsgs subroutine
 in the set of scripts for reading FTN packets (pkt2txt.pl, pkt2xml.pl, etc) by
 Russ Johnson L<ai...@us...> and Robert James Clay L<ja...@us...>
 available at the L<http://ftnpl.sourceforge.net>] project site. Initial code for
-the writepkt function was derived from the bbs2pkt.pl of v0.1 of the bbsdbpl
+the write_ftn_packet function was derived from the bbs2pkt.pl of v0.1 of the bbsdbpl
 scripts, also at the SourceForge project.
 
 =head1 SUPPORT
@@ -412,7 +414,7 @@
 
 =head1 COPYRIGHT & LICENSE
 
-Copyright 2001-2004 Robert James Clay, all rights reserved.
+Copyright 2001-2004,2006 Robert James Clay, all rights reserved.
 Copyright 2001-2003 Russ Johnson, all rights reserved.
 
 This program is free software; you can redistribute it and/or modify it


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.