[LON-CAPA-cvs] cvs: loncom /interface londocs.pm

[jms]

jms		Mon Nov 17 14:46:10 2008 EDT

  Modified files:              
    /loncom/interface	londocs.pm 
  Log:
  Converted comments to POD format
  
Index: loncom/interface/londocs.pm
diff -u loncom/interface/londocs.pm:1.314 loncom/interface/londocs.pm:1.315
--- loncom/interface/londocs.pm:1.314	Wed Oct  8 17:19:18 2008
+++ loncom/interface/londocs.pm	Mon Nov 17 14:46:10 2008
@@ -1,7 +1,7 @@
 # The LearningOnline Network
 # Documents
 #
-# $Id: londocs.pm,v 1.314 2008/10/08 17:19:18 bisitz Exp $
+# $Id: londocs.pm,v 1.315 2008/11/17 14:46:10 jms Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -26,6 +26,22 @@
 # http://www.lon-capa.org/
 #
 
+
+=head1 NAME
+
+Apache::londocs
+
+=head1 SYNOPSIS
+
+This is part of the LearningOnline Network with CAPA project
+described at http://www.lon-capa.org.
+
+=head1 SUBROUTINES
+
+=over
+
+=cut
+
 package Apache::londocs;
 
 use strict;
@@ -53,15 +69,27 @@
 
 my $hadchanges;
 
-# Available help topics
+
+=pod
+
+=item %help=()
+
+ Available help topics
+
+=cut
 
 my %help=();
 
-# Mapread read maps into LONCAPA::map:: global arrays 
-# @order and @resources, determines status
-# sets @order - pointer to resources in right order
-# sets @resources - array with the resources with correct idx
-#
+=pod
+
+=item mapread()
+
+Mapread read maps into LONCAPA::map:: global arrays 
+@order and @resources, determines status
+sets @order - pointer to resources in right order
+sets @resources - array with the resources with correct idx
+
+=cut
 
 sub mapread {
     my ($coursenum,$coursedom,$map)=@_;
@@ -81,7 +109,14 @@
     return ($errtext,0);
 }
 
-# ----------------------------------------- Return hash with valid author names
+
+=pod
+
+=item authorhosts()
+
+    Return hash with valid author names
+
+=cut
 
 sub authorhosts {
     my %outhash=();
@@ -116,7 +151,13 @@
     }
     return ($home,$other,%outhash);
 }
-# ------------------------------------------------------ Generate "dump" button
+=pod
+
+=item dumpbutton()
+
+    Generate "dump" button
+
+=cut
 
 sub dumpbutton {
     my ($home,$other,%outhash)=&authorhosts();
@@ -141,7 +182,14 @@
     $title=~s/[^\w\/\!\$\%\^\*\-\_\=\+\;\:\,\\\|\`\~]+/\_/gs;
     return $title;	
 }
-# -------------------------------------------------------- Actually dump course
+
+=pod
+
+=item dumpcourse()
+
+    Actually dump course
+
+=cut
 
 sub dumpcourse {
     my ($r) = @_;
@@ -263,7 +311,13 @@
     }
 }
 
-# ------------------------------------------------------ Generate "export" button
+=pod
+
+=item exportbutton()
+
+    Generate "export" button
+
+=cut
 
 sub exportbutton {
     my $type = &Apache::loncommon::course_type();
@@ -273,6 +327,12 @@
     &Apache::loncommon::help_open_topic('Docs_Export_Course_Docs').'</div>';
 }
 
+=pod
+
+=item exportcourse()
+
+=cut
+
 sub exportcourse {
     my $r=shift;
     my $type = &Apache::loncommon::course_type();
@@ -911,8 +971,15 @@
     }
 }
 
-# Imports the given (name, url) resources into the course
-# coursenum, coursedom, and folder must precede the list
+=pod
+
+=item group_import()
+
+    Imports the given (name, url) resources into the course
+    coursenum, coursedom, and folder must precede the list
+
+=cut
+
 sub group_import {
     my ($coursenum, $coursedom, $folder, $container, $caller, @files) = @_;
 
@@ -1073,10 +1140,12 @@
     }
 }
 
+=pod
+
+=item docs_change_log()
+
+=cut
 
-#
-# Docs Change Log
-#
 sub docs_change_log {
     my ($r)=@_;
     my $folder=$env{'form.folder'};
@@ -1964,7 +2033,13 @@
     return $line;
 }
 
-# ---------------------------------------------------------------- tie the hash
+=pod
+
+=item tiehash()
+
+tie the hash
+
+=cut
 
 sub tiehash {
     my ($mode)=@_;
@@ -1990,7 +2065,15 @@
     return OK;
 }
 
-# --------------------------------------------------------------- check on this
+
+=pod
+
+=item checkonthis()
+
+check on this
+
+=cut
+
 
 sub checkonthis {
     my ($r,$url,$level,$title)=@_;
@@ -2064,9 +2147,15 @@
 }
 
 
-#
-# ----------------------------------------------------------------- List Symbs
-# 
+
+=pod
+
+=item list_symbs()
+
+List Symbs
+
+=cut
+
 sub list_symbs {
     my ($r) = @_;
 
@@ -2082,9 +2171,14 @@
 }
 
 
-#
-# -------------------------------------------------------------- Verify Content
-# 
+=pod
+
+=item verifycontent()
+
+Verify Content
+
+=cut
+
 sub verifycontent {
     my ($r) = @_;
     my $type = &Apache::loncommon::course_type();
@@ -2114,8 +2208,13 @@
 	     &mt('Return to DOCS').'</a>');
 }
 
+=pod
 
-# -------------------------------------------------------------- Check Versions
+=item devalidateversioncache() & checkversions()
+
+Check Versions
+
+=cut
 
 sub devalidateversioncache {
     my $src=shift;
@@ -2419,7 +2518,13 @@
 $help{'Caching'}.'</span></h3></form>'."\n\n");
 }
 
-# =========================================== Breadcrumbs for special functions
+=pod
+
+=item init_breadcrumbs()
+
+Breadcrumbs for special functions
+
+=cut
 
 sub init_breadcrumbs {
     my ($form,$text)=@_;
@@ -2435,7 +2540,15 @@
 					    bug=>'Instructor Interface'});
 }
 
-# ================================================================ Main Handler
+
+=pod
+
+=item handler()
+
+Main Handler
+
+=cut
+
 sub handler {
     my $r = shift;
     &Apache::loncommon::content_type($r,'text/html');
@@ -3340,3 +3453,9 @@
 }
 1;
 __END__
+
+=pod
+
+=back
+
+=cut