Changeset 142 for trunk/SRC/ToBeReviewed/STRING/strkeywd.pro

Timestamp:

07/21/06 14:47:49 (18 years ago)

Author:

navarro

Message:

english and nicer header (2a)

File:

• trunk/SRC/ToBeReviewed/STRING/strkeywd.pro (modified) (3 diffs)

trunk/SRC/ToBeReviewed/STRING/strkeywd.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME: strkeywd (string keywords)
 ;
-; PURPOSE: traduit une sturcture en un string pouvant etre utilise
-; pour specifier des keywords ds l''appelle d''une fonction qd on
-; utilise execute (cf l''exemple)
+; @file_comments
+; Translate a sturcture in a string able to be used to specify keywords 
+; in the calling of a function when we use EXECUTE (see example)
 ;
-; CATEGORY: pour passer des mots cles avec execute !
+; @categories 
+; 
+; @param STRUCT
+; a structure
 ;
-; CALLING SEQUENCE:res=strkeywd(struct)
-; 
-; INPUTS:struct: une structure
+; @returns
+; a string composed like following:
+; For each element of the structure, we write a part of the string as: 
+;         'name_of_the_element=content_of_the_element'
 ;
-; KEYWORD PARAMETERS:
+; @restrictions
+; If an element of the structure contain an array, it will be convert in a vector.
 ;
-; OUTPUTS:un string compose de la facon suivante:
-;         pour chaque element de la structure, on ecrit une partie du
-;         string sous la forme: 
-;         'nom_de_l''element=contennu de l''element'
+; @restrictions
+; Beware, this function has loops, ifs ad cases everywhere. So it can 
+; not be used by big keywords (with a lot of elements which are big 
+; arrays). The input keyword must not contain Complex floatings, structure, 
+; Double-precision complex, Pointer, Object reference, Unsigned Integer, 
+; Unsigned Longword Integer, 64-bit Integer or Unsigned 64-bit Integer.
 ;
-; COMMON BLOCKS:
-;
-; SIDE EFFECTS:
-;
-;   Si un element de la structure contient un tableau, il sera
-;   convertit en vecteur.
-;
-; RESTRICTIONS:
-;
-;   attention cette fonction comporte des boucles, des if et des cases
-;   ds tous les sens. Elle ne doit donc pas etre utilisee avec des
-;   structure de grosse taille (avec bcp d''elements et avec des
-;   elements etant de gros tableaux).
-;   la structure en entree ne doit pas contenir de Complex floating, de
-;   structure, de Double-precision complex, de Pointer, de Object
-;   reference, de Unsigned Integer, de Unsigned Longword Integer, de
-;   64-bit Integer, de Unsigned 64-bit Integer  
-;
-;
-;
-; EXAMPLE:
-;
-; on cree une structure
+; @examples
+; We create a structure
 ;       IDL> b=get_extra(ok=111, year=[1997,1998,1999], age_capitaine=35)
 ;       IDL> help, b,/struct
@@ -51 +36 @@
 ;          OK              INT            111
 ;          YEAR            INT       Array[3]
-; on met cette structure sous forme de string
+; We put this structure as a string
 ;       IDL> a=strkeywd(b)
 ;       IDL> print, a
 ;       AGE_CAPITAINE=35, OK=111, YEAR=[1997,1998,1999]
-; maintenant on peut utiliser le string a pour passer des mots cles ds
-; une fonction a l''aide de execute!!
+; Now we can use the string a to pass keywords in a function thanks to execute!!
 ;       IDL> test=execute('c=get_extra('+a+')')
 ;       IDL> help, c,/struct
@@ -64 +48 @@
 ;          YEAR            INT       Array[3]
 ;
-; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history
+; Sebastien Masson (smasson@lodyc.jussieu.fr)
 ;                      11/10/1999
+;
+; @version
+; $Id$
+;
 ;-
 ;------------------------------------------------------------