[LON-CAPA-cvs] cvs: loncom /auth localstudentphoto.pm lonacc.pm /interface lonstatistics.pm /publisher londiff.pm lonupload.pm

jms lon-capa-cvs-allow@mail.lon-capa.org
Mon, 10 Nov 2008 13:20:24 -0000


This is a MIME encoded message

--jms1226323224
Content-Type: text/plain

jms		Mon Nov 10 13:20:24 2008 EDT

  Modified files:              
    /loncom/publisher	londiff.pm lonupload.pm 
    /loncom/interface	lonstatistics.pm 
    /loncom/auth	localstudentphoto.pm lonacc.pm 
  Log:
  POD documentation changes
  
--jms1226323224
Content-Type: text/plain
Content-Disposition: attachment; filename="jms-20081110132024.txt"

Index: loncom/publisher/londiff.pm
diff -u loncom/publisher/londiff.pm:1.23 loncom/publisher/londiff.pm:1.24
--- loncom/publisher/londiff.pm:1.23	Mon Jan 15 18:34:32 2007
+++ loncom/publisher/londiff.pm	Mon Nov 10 13:20:04 2008
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # Handler to show differences between file versions
 #
-# $Id: londiff.pm,v 1.23 2007/01/15 18:34:32 albertel Exp $
+# $Id: londiff.pm,v 1.24 2008/11/10 13:20:04 jms Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -27,6 +27,24 @@
 #
 ###
 
+=pod
+
+=head1 NAME
+
+Apache::londiff
+
+=head1 SYNOPSIS
+
+Handler to show difference between two files.
+
+This is part of the LearningOnline Network with CAPA project
+described at http://www.lon-capa.org.
+
+=head2 Subroutines
+
+=cut
+
+
 package Apache::londiff;
 
 use strict;
Index: loncom/publisher/lonupload.pm
diff -u loncom/publisher/lonupload.pm:1.38 loncom/publisher/lonupload.pm:1.39
--- loncom/publisher/lonupload.pm:1.38	Fri Jul 18 03:27:48 2008
+++ loncom/publisher/lonupload.pm	Mon Nov 10 13:20:04 2008
@@ -2,7 +2,7 @@
 # The LearningOnline Network with CAPA
 # Handler to upload files into construction space
 #
-# $Id: lonupload.pm,v 1.38 2008/07/18 03:27:48 raeburn Exp $
+# $Id: lonupload.pm,v 1.39 2008/11/10 13:20:04 jms Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -28,6 +28,92 @@
 #
 ###
 
+=head1 NAME
+
+Apache::lonupload - upload files into construction space
+
+=head1 SYNOPSIS
+
+Invoked by /etc/httpd/conf/srm.conf:
+
+ <Location /adm/upload>
+ PerlAccessHandler       Apache::lonacc
+ SetHandler perl-script
+ PerlHandler Apache::lonupload
+ ErrorDocument     403 /adm/login
+ ErrorDocument     404 /adm/notfound.html
+ ErrorDocument     406 /adm/unauthorized.html
+ ErrorDocument	  500 /adm/errorhandler
+ </Location>
+
+=head1 INTRODUCTION
+
+This module uploads a file sitting on a client computer into 
+library server construction space.
+
+This is part of the LearningOnline Network with CAPA project
+described at http://www.lon-capa.org.
+
+=head1 HANDLER SUBROUTINE
+
+This routine is called by Apache and mod_perl.
+
+=over 4
+
+=item *
+
+Initialize variables
+
+=item *
+
+Start page output
+
+=item *
+
+output relevant interface phase (phaseone or phasetwo or phasethree)
+
+=item *
+
+(phase one is to specify upload file; phase two is to handle conditions
+subsequent to specification--like overwriting an existing file; phase three
+is to handle processing of secondary uploads - of embedded objects in an
+html file).
+
+=back
+
+=head1 OTHER SUBROUTINES
+
+=over 4
+
+=item *
+
+phaseone() : Interface for specifying file to upload.
+
+=item *
+
+phasetwo() : Interface for handling post-conditions about uploading (such
+as overwriting an existing file).
+
+=item *
+
+phasethree() : Interface for handling secondary uploads of embedded objects
+in an html file.
+
+=item *
+
+upfile_store() : Store contents of uploaded file into temporary space.  Invoked
+by phaseone subroutine.
+
+=item *
+
+check_extension() : Checks if filename extension is permitted and checks type
+ of file - if html file, calls parser to check for embedded objects.
+ Invoked by phasetwo subroutine.
+
+=back
+
+=cut
+
 package Apache::lonupload;
 
 use strict;
@@ -377,88 +463,4 @@
 1;
 __END__
 
-=head1 NAME
-
-Apache::lonupload - upload files into construction space
-
-=head1 SYNOPSIS
-
-Invoked by /etc/httpd/conf/srm.conf:
-
- <Location /adm/upload>
- PerlAccessHandler       Apache::lonacc
- SetHandler perl-script
- PerlHandler Apache::lonupload
- ErrorDocument     403 /adm/login
- ErrorDocument     404 /adm/notfound.html
- ErrorDocument     406 /adm/unauthorized.html
- ErrorDocument	  500 /adm/errorhandler
- </Location>
-
-=head1 INTRODUCTION
 
-This module uploads a file sitting on a client computer into 
-library server construction space.
-
-This is part of the LearningOnline Network with CAPA project
-described at http://www.lon-capa.org.
-
-=head1 HANDLER SUBROUTINE
-
-This routine is called by Apache and mod_perl.
-
-=over 4
-
-=item *
-
-Initialize variables
-
-=item *
-
-Start page output
-
-=item *
-
-output relevant interface phase (phaseone or phasetwo or phasethree)
-
-=item *
-
-(phase one is to specify upload file; phase two is to handle conditions
-subsequent to specification--like overwriting an existing file; phase three
-is to handle processing of secondary uploads - of embedded objects in an
-html file).
-
-=back
-
-=head1 OTHER SUBROUTINES
-
-=over 4
-
-=item *
-
-phaseone() : Interface for specifying file to upload.
-
-=item *
-
-phasetwo() : Interface for handling post-conditions about uploading (such
-as overwriting an existing file).
-
-=item *
-
-phasethree() : Interface for handling secondary uploads of embedded objects
-in an html file.
-
-=item *
-
-upfile_store() : Store contents of uploaded file into temporary space.  Invoked
-by phaseone subroutine.
-
-=item *
-
-check_extension() : Checks if filename extension is permitted and checks type
- of file - if html file, calls parser to check for embedded objects.
- Invoked by phasetwo subroutine.
-
-=back
-
-=cut
Index: loncom/interface/lonstatistics.pm
diff -u loncom/interface/lonstatistics.pm:1.142 loncom/interface/lonstatistics.pm:1.143
--- loncom/interface/lonstatistics.pm:1.142	Wed Oct 22 10:53:21 2008
+++ loncom/interface/lonstatistics.pm	Mon Nov 10 13:20:14 2008
@@ -1,6 +1,6 @@
 # The LearningOnline Network with CAPA
 #
-# $Id: lonstatistics.pm,v 1.142 2008/10/22 10:53:21 bisitz Exp $
+# $Id: lonstatistics.pm,v 1.143 2008/11/10 13:20:14 jms Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -38,6 +38,9 @@
 
 Main handler for statistics and chart.
 
+This is part of the LearningOnline Network with CAPA project
+described at http://www.lon-capa.org.
+
 =over 4
 
 =cut
Index: loncom/auth/localstudentphoto.pm
diff -u loncom/auth/localstudentphoto.pm:1.4 loncom/auth/localstudentphoto.pm:1.5
--- loncom/auth/localstudentphoto.pm:1.4	Fri Feb 10 02:38:59 2006
+++ loncom/auth/localstudentphoto.pm	Mon Nov 10 13:20:24 2008
@@ -1,6 +1,6 @@
 # The LON-CAPA dummy student photo fetch mechnism
 #
-# $Id: localstudentphoto.pm,v 1.4 2006/02/10 02:38:59 raeburn Exp $
+# $Id: localstudentphoto.pm,v 1.5 2008/11/10 13:20:24 jms Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -27,6 +27,8 @@
 # 8/24 Guy Albertelli
 
 
+
+
 package localstudentphoto;
 use lib '/home/httpd/lib/perl/';
 use LONCAPA::Configuration;
@@ -80,20 +82,6 @@
     my $thumbsize = '40x40';
     return ($fullsize,$thumbsize);
 }
-
-###############################
-# sub AUTOLOAD
-#
-# Incoming data: none
-# Returns ''
-#
-# Prevents errors when undefined subroutines are called in this package
-# Will allow new routines added in the future to be called from lond etc.
-# without the need for customized versions of local*.pm packages to be
-# modified to include the new subroutines immediately.
-#
-# See "Programming Perl" 3rd ed. pp 296-298.
-###############################
                                                                                 
 sub AUTOLOAD {
     our $AUTOLOAD;
@@ -102,3 +90,26 @@
 
 1;
 __END__
+
+=pod
+
+=head1 NAME
+
+AUTOLOAD
+
+=head1 SYNOPSIS
+
+Incoming data: none
+Returns ''
+
+=head1 OVERVIEW
+
+Prevents errors when undefined subroutines are called in this package. 
+Will allow new routines added in the future to be called from lond etc.
+without the need for customized versions of local*.pm packages to be
+modified to include the new subroutines immediately.
+
+See I<"Programming Perl"> 3rd ed. pp 296-298.
+
+=cut
+
Index: loncom/auth/lonacc.pm
diff -u loncom/auth/lonacc.pm:1.116 loncom/auth/lonacc.pm:1.117
--- loncom/auth/lonacc.pm:1.116	Mon Sep 15 19:08:44 2008
+++ loncom/auth/lonacc.pm	Mon Nov 10 13:20:24 2008
@@ -1,7 +1,7 @@
 # The LearningOnline Network
 # Cookie Based Access Handler
 #
-# $Id: lonacc.pm,v 1.116 2008/09/15 19:08:44 raeburn Exp $
+# $Id: lonacc.pm,v 1.117 2008/11/10 13:20:24 jms Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -150,6 +150,7 @@
 # balance them
 # returns OK if it was a SSO and user was handled
 #         undef if not SSO or no means to hanle the user
+
 sub sso_login {
     my ($r,$handle) = @_;
 

--jms1226323224--