[120833] branches/gsoc14-interactive/API Description.txt

[shasha at macports.org]

Revision: 120833
          https://trac.macports.org/changeset/120833
Author:   shasha at macports.org
Date:     2014-06-09 02:59:17 -0700 (Mon, 09 Jun 2014)
Log Message:
-----------
Naming the parameters correctly

Modified Paths:
--------------
    branches/gsoc14-interactive/API Description.txt

Modified: branches/gsoc14-interactive/API Description.txt
===================================================================
--- branches/gsoc14-interactive/API Description.txt	2014-06-09 06:34:02 UTC (rev 120832)
+++ branches/gsoc14-interactive/API Description.txt	2014-06-09 09:59:17 UTC (rev 120833)
@@ -4,58 +4,55 @@
 
 ui_ask_yesno 
 DESC: Displays a question with 'yes' and 'no' as options. Waits for user input indefinitely unless a timeout is specified.
-	  Shows the list of port passed to it without any numbers.
+Shows the list of port passed to it without any numbers.
 
 PARAMETERS: (may change)
-			"message": Message as a string
-			portname : Name of the port which triggered the question
-			<list>   : May contain one or more portnames 
-			def		 : The default answer for the question
-			10s	 	 : Time for timeout (with 0 as default value which signifies no timeout)
+			msg	 : Message as a string
+			name 	 : Name of the port which triggered the question
+			ports    : May contain one or more portnames 
+			def 	 : The default answer for the question
+			time	 : Time for timeout (with 0 as default value which  signifies no timeout)
 			
 RETURN VALUES: Return a unique value for each case
-			   -1: Timeout occured
-			   -2: Default
-			    0: Yes
-				1: No
+			       -1: Timeout occured
+	    			0: Yes
+	    			1: No
 				
 ui_ask_singlechoice
 DESC: Displays a question with a list of numbered choices and asks the user to enter a number to specify their choice.
-	  Waits for user input indefinitely unless a timeout is specified.
+Waits for user input indefinitely unless a timeout is specified.
 
 PARAMETERS: (may change)
-			"message": Message as a string
-			portname : Name of the port which triggered the question
-			<list>   : May contain one or more portnames 
-			def		 : The default answer for the question
-			10s	 	 : Time for timeout (with 0 as default value which signifies no timeout)
+			msg	 : Message as a string
+			name 	 : Name of the port which triggered the question
+			ports    : May contain one or more portnames 
+			def      : The default answer for the question
+			time	 : Time for timeout (with 0 as default value which signifies no timeout)
 			
 RETURN VALUES: Return a unique value for each case
-			   -1: Timeout occured
-			   -2: Default
-			    i: Index of the list that was initially passed to the function
-				
+			       -1: Timeout occured
+			    	i: Index of the list that was initially passed to the  function
+					
 ui_ask_multichoice
 DESC: Displays a question with a list of numbered choices and asks the user to enter a space separated string of numbers to specify their choice.
-	  Waits for user input indefinitely unless a timeout is specified.
+Waits for user input indefinitely unless a timeout is specified.
 
 PARAMETERS: (may change)
-			"message": Message as a string
-			portname : Name of the port which triggered the question
-			<list>   : May contain one or more portnames 
-			def		 : The default answer for the question
-			10s	 	 : Time for timeout (with 0 as default value which signifies no timeout)
+			msg	 : Message as a string
+			name	 : Name of the port which triggered the question
+			ports	 : May contain one or more portnames 
+			def	 : The default answer for the question
+			time	 : Time for timeout (with 0 as default value which signifies no timeout)
 			
 RETURN VALUES: Return a unique value for each case
-			   -1: Timeout occured
-			   -2: Default
-		   <list>: Indices of the list that was initially passed in the form of a list
+			       -1: Timeout occured
+		   	choices	 : Indices of the list that was initially passed in the form of a list
  
 ui_timeout
 DESC: Function internal to the client that prints the visualisation for a timeout. Runs for the specified time interval.
 
 PARAMETERS: (may change)
-			10s	: Time for timeout 
+			time	: Time for timeout 
 			
 RETURN VALUES: Return a unique value for each case
 			   1: Timeout completed
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.macosforge.org/pipermail/macports-changes/attachments/20140609/e2827b29/attachment-0001.html>