--- loncom/homework/response.pm 2008/11/24 16:53:26 1.207 +++ loncom/homework/response.pm 2008/11/25 13:16:17 1.208 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # various response type definitons response definition # -# $Id: response.pm,v 1.207 2008/11/24 16:53:26 jms Exp $ +# $Id: response.pm,v 1.208 2008/11/25 13:16:17 jms Exp $ # # Copyright Michigan State University Board of Trustees # @@ -26,6 +26,29 @@ # http://www.lon-capa.org/ # +=pod + +=head1 NAME + +Apache::resonse.pm + +=head1 SYNOPSIS + +This is part of the LearningOnline Network with CAPA project +described at http://www.lon-capa.org. + + +=head1 NOTABLE SUBROUTINES + +=over + +=item + +=back + +=cut + + package Apache::response; use strict; use Apache::lonlocal; @@ -1153,17 +1176,20 @@ sub pick_foil_for_concept { $Apache::response::conceptgroup{'names'}; } -#------------------------------------------------------------ -# -# Get a parameter associated with a problem. -# Parameters: -# $id - the id of the paramater, either a part id, -# or a partid and responspe id joined by _ -# $name - Name of the parameter to fetch -# $default - Default value for the paramter. -# -# -# + +=pod + +=item get_response_param() + +Get a parameter associated with a problem. +Parameters: + $id - the id of the paramater, either a part id, + or a partid and responspe id joined by _ + $name - Name of the parameter to fetch + $default - Default value for the paramter. + +=cut + sub get_response_param { my ($id,$name,$default)=@_; my $parameter; @@ -1224,14 +1250,21 @@ sub add_to_gradingqueue { } } -# basically undef and 0 (both false) mean that they still have work to do -# and all true values mean that they can't do any more work -# -# a return of undef means it is unattempted -# a return of 0 means it is attmpted and wrong but still has tries -# a return of 1 means it is marked correct -# a return of 2 means they have exceed maximum number of tries -# a return of 3 means it after the answer date +=pod + +=item check_status() + +basically undef and 0 (both false) mean that they still have work to do +and all true values mean that they can't do any more work + + a return of undef means it is unattempted + a return of 0 means it is attmpted and wrong but still has tries + a return of 1 means it is marked correct + a return of 2 means they have exceed maximum number of tries + a return of 3 means it after the answer date + +=cut + sub check_status { my ($id)=@_; if (!defined($id)) { $id=$Apache::inputtags::part; } @@ -1299,3 +1332,8 @@ sub setup_prior_tries_hash { 1; __END__ +=pod + +=back + +=cut \ No newline at end of file