[LON-CAPA-cvs] cvs: loncom /homework hint.pm lonhomework.pm

[jms]

jms		Wed Nov 19 18:34:56 2008 EDT

  Modified files:              
    /loncom/homework	hint.pm lonhomework.pm 
  Log:
  Converted/added POD comments
  
Index: loncom/homework/hint.pm
diff -u loncom/homework/hint.pm:1.72 loncom/homework/hint.pm:1.73
--- loncom/homework/hint.pm:1.72	Fri Oct 24 16:22:54 2008
+++ loncom/homework/hint.pm	Wed Nov 19 18:34:56 2008
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA 
 # implements the tags that control the hints
 #
-# $Id: hint.pm,v 1.72 2008/10/24 16:22:54 bisitz Exp $
+# $Id: hint.pm,v 1.73 2008/11/19 18:34:56 jms Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -26,6 +26,61 @@
 # http://www.lon-capa.org/
 #
 
+=head1 NAME
+
+Apache::hinttags
+
+=head1 SYNOPSIS
+
+This handler coordinates the delivery of hints to students working on LON-CAPA problems and assignments.
+
+This is part of the LearningOnline Network with CAPA project
+described at http://www.lon-capa.org.
+
+=head1 SUBROUTINES
+
+=over
+
+=item start_hintgroup()
+
+=item end_hintgroup()
+
+=item start_numericalhint()
+
+=item end_numericalhint()
+
+=item start_formulahint()
+
+=item end_formulahint()
+
+=item start_mathhint()
+
+=item end_mathhint()
+
+=item start_customhint()
+
+=item end_customhint()
+
+=item start_stringhint()
+
+=item end_stringhint()
+
+=item start_hintpart()
+
+=item end_hintpart()
+
+=item start_optionhint()
+
+=item end_optionhint()
+
+=item start_radiobuttonhint()
+
+=item end_radiobuttonhint()
+
+=back
+
+=cut
+
 package Apache::hinttags; 
 
 use strict;
Index: loncom/homework/lonhomework.pm
diff -u loncom/homework/lonhomework.pm:1.298 loncom/homework/lonhomework.pm:1.299
--- loncom/homework/lonhomework.pm:1.298	Tue Oct  7 10:13:06 2008
+++ loncom/homework/lonhomework.pm	Wed Nov 19 18:34:56 2008
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # The LON-CAPA Homework handler
 #
-# $Id: lonhomework.pm,v 1.298 2008/10/07 10:13:06 foxr Exp $
+# $Id: lonhomework.pm,v 1.299 2008/11/19 18:34:56 jms Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -85,14 +85,20 @@
     }
 }
 
-#
-# Decides what targets to render for.
-# Implicit inputs:
-#   Various session environment variables:
-#      request.state -  published  - is a /res/ resource
-#                       uploaded   - is a /uploaded/ resource
-#                       contruct   - is a /priv/ resource
-#      form.grade_target - a form parameter requesting a specific target
+=pod
+
+=item get_target()
+
+Decides what targets to render for.
+Implicit inputs:
+  Various session environment variables:
+     request.state -  published  - is a /res/ resource
+                      uploaded   - is a /uploaded/ resource
+                      contruct   - is a /priv/ resource
+     form.grade_target - a form parameter requesting a specific target
+
+=cut
+
 sub get_target {
     &Apache::lonxml::debug("request.state = $env{'request.state'}");
     if( defined($env{'form.grade_target'})) {
@@ -331,8 +337,16 @@
     return ($slotstatus,$datemsg,$slot_name,$returned_slot);
 }
 
-# JB, 9/24/2002: Any changes in this function may require a change
-# in lonnavmaps::resource::getDateStatus.
+
+=pod
+
+=item check_access()
+
+JB, 9/24/2002: Any changes in this function may require a change
+in lonnavmaps::resource::getDateStatus.
+
+=cut
+
 sub check_access {
     my ($id) = @_;
     my $date ='';
@@ -480,7 +494,16 @@
 
     return ($status,$datemsg);
 }
-# this should work exactly like the copy in lonnavmaps.pm
+
+
+=pod 
+
+=item due_date()
+
+    this should work exactly like the copy in lonnavmaps.pm
+
+=cut
+
 sub due_date {
     my ($part_id,$symb,$udom,$uname)=@_;
     my $date;
@@ -938,9 +961,14 @@
     return '';
 }
 
-#
-#    Render the page in whatever target desired.
-#
+=pod
+
+=item renderpage()
+
+    Render the page in whatever target desired.
+
+=cut
+
 sub renderpage {
     my ($request,$file,$targets,$return_string) = @_;