r15876 - gnucash/trunk/src/app-utils - Fix indentation; clarify comment/description of vector of functions.

Josh Sled jsled at cvs.gnucash.org
Wed Apr 11 17:58:49 EDT 2007


Author: jsled
Date: 2007-04-11 17:58:48 -0400 (Wed, 11 Apr 2007)
New Revision: 15876
Trac: http://svn.gnucash.org/trac/changeset/15876

Modified:
   gnucash/trunk/src/app-utils/options.scm
Log:
Fix indentation; clarify comment/description of vector of functions.


Modified: gnucash/trunk/src/app-utils/options.scm
===================================================================
--- gnucash/trunk/src/app-utils/options.scm	2007-04-11 16:47:42 UTC (rev 15875)
+++ gnucash/trunk/src/app-utils/options.scm	2007-04-11 21:58:48 UTC (rev 15876)
@@ -35,33 +35,35 @@
          ;; option. The function should restore the option to the original
          ;; value.
          generate-restore-form
-	 ;; the scm->kvp and kvp->scm functions should save and load
-	 ;; the option to a kvp.  The arguments to these function will be
-	 ;; a kvp-frame and a base key-path list for this option.
-	 scm->kvp
-	 kvp->scm	 
+         ;; the scm->kvp and kvp->scm functions should save and load
+         ;; the option to a kvp.  The arguments to these function will be
+         ;; a kvp-frame and a base key-path list for this option.
+         scm->kvp
+         kvp->scm	 
          ;; Validation func should accept a value and return (#t value)
          ;; on success, and (#f "failure-message") on failure. If #t,
          ;; the supplied value will be used by the gui to set the option.
          value-validator
-	 ;;; free-form storage depending on type.
+         ;;; free-form storage depending on type.
          option-data 
-	 ;; If this is a "multiple choice" type of option,
-	 ;; this should be a vector of the following five functions
-	 ;; one taking no arguments giving the number of choices
-         ;; one taking one argument, a non-negative integer, that
+         ;; If this is a "multiple choice" type of option,
+         ;; this should be a vector of the following five functions:
+         ;; 
+         ;; Function 1: taking no arguments, giving the number of choices
+         ;;
+         ;; Function 2: taking one argument, a non-negative integer, that
          ;; returns the scheme value (usually a symbol) matching the
          ;; nth choice
          ;;
-	 ;; one taking one argument, a non-negative integer,
-	 ;; that returns the string matching the nth choice
+         ;; Function 3: taking one argument, a non-negative integer,
+         ;; that returns the string matching the nth choice
          ;;
-	 ;; the third takes one argument and returns the description
-	 ;; containing the nth choice
-	 ;;
-	 ;; the fourth giving a possible value and returning the index
-	 ;; if an option doesn't use these,  this should just be a #f
-	 option-data-fns
+         ;; Function 4: takes one argument and returns the description
+         ;; containing the nth choice
+         ;;
+         ;; Function 5: giving a possible value and returning the index
+         ;; if an option doesn't use these,  this should just be a #f
+         option-data-fns
          ;; This function should return a list of all the strings
          ;; in the option other than the section, name, (define
          ;; (list-lookup list item) and documentation-string that



More information about the gnucash-changes mailing list