Changeset 133 for trunk/SRC/Utilities/testvar.pro

Timestamp:

07/07/06 11:57:27 (18 years ago)

Author:

navarro

Message:

english and nicer header (1)

File:

• trunk/SRC/Utilities/testvar.pro (moved) (moved from trunk/SRC/ToBeReviewed/UTILITAIRE/testvar.pro) (1 diff)

trunk/SRC/Utilities/testvar.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:testvar
 ;
-; PURPOSE:une sorte de keyword_set mais qd la valeur existe renvoie
-; celle-ci
+; @file_comments 
+; A  kind of keyword_set but when the value exist, it send it back
 ;
-; CATEGORY:comme keyword_set
+; @categories utlities
 ;
-; CALLING SEQUENCE:res=testvar(var=variable)
-; 
-; INPUTS:rien
+; @keyword var any kind of
 ;
-; KEYWORD PARAMETERS:var : n''importe quoi
+; @returns 0 if the variable does not exist 
 ;
-; OUTPUTS:0 si la variable n''existe pas 
-;
-; COMMON BLOCKS:
-;
-; SIDE EFFECTS:
-;
-; RESTRICTIONS:
-;
-; EXAMPLE:
-;
-;    IDL> print, testvar(var=toto)
+; @examples IDL> print, testvar(var=toto)
 ;           0
 ;    IDL> print, testvar(var='toto')
 ;    toto
 ;
-; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history Sebastien Masson (smasson@lodyc.jussieu.fr)
 ;                      14/12/1999
+;
+; @version $Id$
+;
 ;-
 ;------------------------------------------------------------