Changeset 136 for trunk/SRC/Utilities/report.pro

Timestamp:

07/10/06 17:20:19 (18 years ago)

Author:

pinsard

Message:

some improvements and corrections in some .pro file according to
aspell and idldoc log file

File:

• trunk/SRC/Utilities/report.pro (modified) (1 diff)

trunk/SRC/Utilities/report.pro

@@ -9 +9 @@
 ; To ask a question whose answer is not yes/no,use xquestion.
 ;
-; @param text {in}{required} un string on un vecteur de string. Si le string ne
+; @param text {in}{required} 
+; one string or one vector of string. Si le string ne
 ; comporte qu''un element, on cherche les eventuels characteres de
 ; retour a la ligne: '!C'. If text is set to an array of strings, each
 ; array element is displayed as a separate line of text.
 ;
-; @keyword SIMPLE activate to print only the message without the name
-;             and the line of the routine (defined by calling routine_name)
+; @keyword SIMPLE 
+; activate to print only the message without the name
+; and the line of the routine (defined by calling routine_name)
 ;
-; @keyword _extra used to pass keywords from dialog_message.pro and message.pro
+; @keyword _extra 
+; used to pass keywords from dialog_message.pro and message.pro
 ;
-; @keyword PARENT same as DIALOG_PARENT de dialog_message.pro
+; @keyword PARENT 
+; same as DIALOG_PARENT de dialog_message.pro
 ;
-; @keyword QUESTION Set this keyword to create a "Question" dialog.
-;                   The default dialog type is "Warning"
+; @keyword QUESTION {default="Warning"}
+; Set this keyword to create a "Question" dialog.
 ;
-; @keyword DEFAULT_NO Set this keyword to make the "No" button the default 
-;                     selection for "Question" dialog. Normally, the default is yes.
+; @keyword DEFAULT_NO {default="Yes"}
+; Set this keyword to make the "No" button the default selection for 
+; "Question" dialog. 
 ;
-; @keyword SIMPLE Activate to print the error message without printing 
-;                 the routine name with its full path.
+; @keyword SIMPLE 
+; Activate to print the error message without printing  the routine name with 
+; its full path.
 ;
-; @returns -1 if the keyword QUESTION is not activated
-;          If the keyword is activated, return 1 for yes and 0 for no.
+; @returns 
+; -1 if the keyword QUESTION is not activated
+; If the keyword is activated, return 1 for yes and 0 for no.
 ; 
-; @example If there is not any widget activated:
+; @examples 
+; If there is not any widget activated:
 ;
-;     IDL> help, report('toto tata')
-;     % $MAIN$: toto tata
-;     <Expression>    INT       =       -1
-;     IDL> help, report('does it works ?',/question)
-;     does it works ? y/n (default answer is y)
-;     <Expression>    BYTE      =    1
-;     IDL> help, report('question1: !C does it works ?',/question)
-;     question1:
-;     does it works ? y/n (default answer is y)
-;     <Expression>    BYTE      =    1
+; IDL> help, report('toto tata')
+; % $MAIN$: toto tata
+; <Expression>    INT       =       -1
+; IDL> help, report('does it works ?',/question)
+; does it works ? y/n (default answer is y)
+; <Expression>    BYTE      =    1
+; IDL> help, report('question1: !C does it works ?',/question)
+; question1:
+; does it works ? y/n (default answer is y)
+; <Expression>    BYTE      =    1
 ;
 ; If widgets are already activated, it is the same thing but with widgets!
 ;
-; @history Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history Sebastien Masson (smasson\@lodyc.jussieu.fr)
 ;                      21/10/1999
 ;
-; @version $ID$
+; @version $Id$
 ;
 ;-