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

Timestamp:

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

Author:

navarro

Message:

english and nicer header (2a)

File:

• trunk/SRC/ToBeReviewed/STRING/chkeywd.pro (modified) (4 diffs)

trunk/SRC/ToBeReviewed/STRING/chkeywd.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME: chkeywd (change keyword)
 ;
-; PURPOSE: ds un string qui contient une commande a executer avec
-; EXECUTE par ex. On change la valeur d''un des mot cle.
-; Plus generalement, ds un string, on cherche la chaine de
-; chacarteres: ', keywdname= ..., et on change la valeur de ...
+; @file_comments
+; In a string containing an order to executewith EXECUTE by example. 
+; We change the value of one of keywords.
+; More generally, in a string, we look for the caracter chain: ', keywdname= ...,
+; and we change the value of...
 ;
-; CATEGORY: pour bidouiller des commandes passees par execute
+; @categories
+; string, keywords
 ;
-; CALLING SEQUENCE: stringout=chkeywd(stringin, keywdname, keywdvalue)
 ; 
-; INPUTS:
-;      stringin: un string
-;      keywdname: un string designant le nom du mot clef a chercher.
-;      keywdvalue: nouvelle valeur du mot clef a considerer ds stringin
+; @param STRINGIN {in}{required}
+; it is a string
 ;
-; KEYWORD PARAMETERS:
-;      pour chercher le mot cle, on cherche le premier signe = qui
-;      suit la position de keywdname. on substitue
-;      pardefaut tout le bout de string qui suit jusqu''a la prochaine
-;      virgule. avec les mots cles SEPARATOR et AFTER on peut modifier
-;      cette decoupe du string:
-;      SEPARATOR donne un chatactere avant (ou apres si AFTER est
-;      active) lequel il faut chercher la virgule qui delimite le mot
-;      cle ds le string. cf. les exemples
+; @param KEYWDNAME {in}{required}
+; it is a string designating the name of keyword to look for.
 ;
-; OUTPUTS:stringout=stringin modifie si keywdname a ete trouve ds
-; stringin
+; @param KEYWDVALUE {in}{required} 
+; The new value of the keyword to considerate in STRINGIN
 ;
-; COMMON BLOCKS:common.pro
+; @keyword SEPARATOR
+; To look for the keyword, we look for the first sign = which follow 
+; the position of keywdname. By default, we substitute the string 
+; before the comma. With the keyword SEPARATOR,we can modify the cut 
+; of the string. SEPARATOR give a caractere before the one we have to 
+; look for the comma which delimit the keyword in the string.
+; (see examples)
 ;
-; SIDE EFFECTS:
-;   
-;   Si keywdvalue est un tableau, il sera convertit en vecteur.
+; @keyword AFTER
+; To look for the keyword, we look for the first sign = which follow 
+; the position of keywdname. By default, we substitute the string 
+; before the comma. With the keyword AFTER,we can modify the cut 
+; of the string. AFTER give a caractere after the one we have to 
+; look for the comma which delimit the keyword in the string.
+; (see examples)
 ;
-; RESTRICTIONS:
+; @returns 
+; stringout=stringin modified if keywdname has been found in stringin
 ;
-;   attention cette fonction comporte des boucles, des if et des cases
-;   ds tous les sens. Elle ne doit donc pas etre utilisee avec des
-;   mots clefs de grosse taille (avec bcp d''elements et avec des
-;   elements etant de gros tableaux).
-;   le mot clef 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  
+; @uses 
+; common.pro
 ;
-; EXAMPLE:
+; @restrictions
+; If keywdvalue is an array, it will be convert in a vector.
+;
+; @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.
+; 
+;
+; @examples
 ;
 ;   IDL> b='ok=111, year=[1997,1998,1999], age_capitaine=35'
@@ -64 +71 @@
 ;   ok=111, year='c''est bon', /age_capitaine
 ;
-; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history
+; Sebastien Masson (smasson@lodyc.jussieu.fr)
 ;                      18/10/1999
-;                      24/11/1999: adaptation pour les mots cles
-;                      commencant par /
+;                      24/11/1999: adaptation for keywords starting by /
+; 
+; @version
+; $Id$
+;
 ;-
 ;------------------------------------------------------------
@@ -81 +92 @@
    if poskeywd EQ -1 then return, stringout
    while poskeywd NE -1 do BEGIN
-; changer un mot cle qui commence par /toto
+; change a keyword starting by /toto
       if strmid(stringout,poskeywd-1,1) EQ '/' then BEGIN
          ajoute = keywdname+'='+tostr(keywdvalue)
@@ -88 +99 @@
          poskeywd = strpos(stringout, keywdname, poskeywd)
       ENDIF ELSE BEGIN 
-; changer un mot cle qui commence par toto=
+; change a keyword sarting by toto=
          posegal = strpos(stringout, '=', poskeywd)
          if posegal EQ -1 then return, stringout