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

[foxr]

foxr		Thu Nov  3 06:11:25 2005 EDT

  Modified files:              
    /loncom/homework	inputtags.pm 
  Log:
  "improve?" some commenting of the global variables so that it may
  be easier for th eye to extract what they mean.
  
  
Index: loncom/homework/inputtags.pm
diff -u loncom/homework/inputtags.pm:1.176 loncom/homework/inputtags.pm:1.177
--- loncom/homework/inputtags.pm:1.176	Tue Oct 18 17:46:42 2005
+++ loncom/homework/inputtags.pm	Thu Nov  3 06:11:25 2005
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # input  definitons
 #
-# $Id: inputtags.pm,v 1.176 2005/10/18 21:46:42 albertel Exp $
+# $Id: inputtags.pm,v 1.177 2005/11/03 11:11:25 foxr Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -36,42 +36,52 @@
     &Apache::lonxml::register('Apache::inputtags',('hiddenline','textfield','textline'));
 }
 
-
+#   Initializes a set of global variables used during the parse of the problem.
+#   (I like this way of documenting variables better since
+#    you don't have to rake your eyes over as much code rf).
+#
+#    @Apache::inputtags::input        - List of current input ids.
+#    @Apache::inputtags::inputlist    - List of all input ids seen this problem.
+#    @Apache::inputtags::response     - List of all current resopnse ids.
+#    @Apache::inputtags::responselist - List of all response ids seen this problem.
+#    @Apache::inputtags::hint         - List of all hint ids.
+#    @Apache::inputtags::hintlist     - List of all hint ids seen this problem.
+#    @Apache::inputtags::previous     - List describing if specific responseds have been used
+#    @Apache::inputtags::previous_version - Submission responses were used in.
+#    $Apache::inputtags::part         - Current part id (valid only in <problem>
+#                                       0 if not in a part.
+#    @Apache::inputtags::partlist     - List of part ids seen in the current <problem>
+#    @Apache::inputtags::status       - List of problem  statuses. First element
+#                                       is the status of the <problem> the remainder
+#                                       are for individual <part>s.
+#    %Apache::inputtags::params       - Hash of defined parameters for the current
+#                                       response.
+#    @Apache::inputtags::import       - List of all ids for <import> thes get
+#                                       join()ed and prepended.
+#    @Apache::inputtags::importlist   - List of all import ids seen.
+#    $Apache::inputtags::response_with_no_part
+#                                     - Flag set true if we have seen a response
+#                                       that is not inside a <part>
+#    %Apache::inputtags::answertxt    - <*response> tags store correct
+#                                       answer strings for display by <textline/>
+#                                       in this hash.
+#
 sub initialize_inputtags {
-    # list of current input ids
     @Apache::inputtags::input=();
-    # list of all input ids seen in this problem
     @Apache::inputtags::inputlist=();
-    # list of all current response ids
     @Apache::inputtags::response=();
-    # list of all response ids seen in this problem
     @Apache::inputtags::responselist=();
-    # list of all current hint ids
     @Apache::inputtags::hint=();
-    # list of all hint ids seen in this problem
     @Apache::inputtags::hintlist=();
-    # list of whether or not a specific response was previously used
     @Apache::inputtags::previous=();
-    # submission it was used in
     @Apache::inputtags::previous_version=();
-    # id of current part, 0 means that no part is current 
-    # (inside <problem> only
     $Apache::inputtags::part='';
-    # list of all part ids seen
     @Apache::inputtags::partlist=();
-    # list of problem date statuses, the first element is for <problem>
-    # if there is a second element it is for the current <part>
     @Apache::inputtags::status=();
-    # hash of defined params for the current response
     %Apache::inputtags::params=();
-    # list of all ids, for <import>, these get join()ed and prepended
     @Apache::inputtags::import=();
-    # list of all import ids seen
     @Apache::inputtags::importlist=();
-    # just used to note whether we have seen a response that isn't in a part
     $Apache::inputtags::response_with_no_part=0;
-    # storage location so the begin <*response> tag can generate the correct
-    # answer string for display by the <textline />
     %Apache::inputtags::answertxt=();
 }