Changeset 150 for trunk/SRC/ToBeReviewed/WIDGET/xnotice.pro

Timestamp:

08/09/06 12:12:54 (18 years ago)

Author:

navarro

Message:

english and nicer header (3a)

File:

• trunk/SRC/ToBeReviewed/WIDGET/xnotice.pro (modified) (2 diffs)

trunk/SRC/ToBeReviewed/WIDGET/xnotice.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:xnotice
 ;
-; PURPOSE:cree un widget avec du texte au milieu de la fenetre.
+; @file_comments
+; Create a widget with some text at the middle of the window
 ;
-; CATEGORY:information
+; @categories
+; Information
+; 
+; @param TEXT {in}{required}
+; it is a string or a vector of string. If it is a scalar, we 
+; look for the line separator !C to create a text with several lines.
 ;
-; CALLING SEQUENCE:widgetid=xnotice(text)
-; 
-; INPUTS:text: un string ou un vecteur de string. Si c''est un
-; scalaire on cherche le separateur de ligne !C pour creer un texte a
-; plusieurs lignes.
+; @keyword CHKWIDGET
+; Force to verify that they are some active widget to create a widget, 
+; otherwise print at the prompt
 ;
-; KEYWORD PARAMETERS:chkwidget: oblige a verifier qu''il y a des
-; widgets actif pour creer un widget, sinon imprime au prompt
+; @returns
+; The identity of the created widget
 ;
-; OUTPUTS:lidentite du widget cree
-;
-; COMMON BLOCKS
-;
-; SIDE EFFECTS:ne fait pas appelle a xmanager -> ne cree aucun event!
-; il faut detruire ce widget a la main:
+; @restrictions 
+; It do not call xmanager -> It do not create any event! 
+; We have to delete this widget manuelly:
 ; widget_control, widgetid, /destroy
 ;
-; RESTRICTIONS:
-;
-; EXAMPLE:
+; @examples
 ;    IDL> id=xnotice('ca marche !C ou pas?')
 ;    IDL> widget_control, id, /destroy
 ;
-; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history
+; Sebastien Masson (smasson@lodyc.jussieu.fr)
 ;                      2000 3 17
+;
+; @version
+; $Id$
+;
 ;-
 ;------------------------------------------------------------
@@ -40 +43 @@
 FUNCTION xnotice, text, CHKWIDGET = chkwidget
 ;
-; on separe le text en differentes lignes (separees par !C) si ce
+; We separate the text in different lines (separated by !C) if it is not done yet...
 ; n''est pas deja fait...
 ;