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

Timestamp:

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

Author:

navarro

Message:

english and nicer header (1)

File:

• trunk/SRC/Utilities/routine_name.pro (moved) (moved from trunk/SRC/ToBeReviewed/UTILITAIRE/routine_name.pro) (3 diffs)

trunk/SRC/Utilities/routine_name.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:routine_name,remonte
 ;
-; PURPOSE:retourne le nom de la routine (procedure ou function) ds
-; lequel on se trouve
+; @file_comments 
+; Give us the name of the routine (procedure or function) where we are.
 ;
-; CATEGORY:utilitaire
+; @categories utilities
+; 
+; @param pilingnum {in}{optional} A whole number which give us how many level we have to reascend 
+;                in the piling up of routines and subroutines to find the looked for routine.
 ;
-; CALLING SEQUENCE:res=routine_name([remonte])
-; 
-; INPUTS: remonte: un entier qui donne de combien de niveau on doit
-; remonter ds l''empillement des routines ewt sous-routines pour
-; retrouver le nom de la routine cherchee
 ;
-; KEYWORD PARAMETERS:
+; @returns a string giving either the full name of the routine (with the path) or '$MAIN$'
 ;
-; OUTPUTS:un string donnant soit le nom de la routine en entier (avec
-; le path) soit '$MAIN$'
+; @restriction This function use the keyword OUTPUT in help.pro and it is specified 
+;              in the online help that the return syntax of this word can change in 
+;              function of the version of the code. This version works with IDL 5.2.
 ;
-; COMMON BLOCKS:
-;
-; SIDE EFFECTS:
-;
-; RESTRICTIONS:
-;   cette fonction utilise le mot cle OUTPUT ds help.pro et il est
-;   specifie ds l''aide en ligne que la syntaxe du retour de ce mot cle
-;   peut changer suivant la version du code. Cette version marche avec
-;   IDL 5.2
-;
-; EXAMPLE:
-;
-;  IDL> print, routine_name()
+; @example IDL> print, routine_name()
 ;  /usr1/com/smasson/IDL_RD/UTILITAIRE/report.pro
 ;  IDL> print, routine_name(1)
@@ -44 +30 @@
 ;  $MAIN$
 ;
-; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history Sebastien Masson (smasson@lodyc.jussieu.fr)
 ;                      21/10/1999
+;
+; @version $Id$
+;
 ;-
 ;------------------------------------------------------------
 ;------------------------------------------------------------
 ;------------------------------------------------------------
-FUNCTION routine_name,  remonte
+FUNCTION routine_name,  pilingnum
 ;
 ;
@@ -56 +45 @@
 ;
   help,  /traceback, output = name
-  name = strtrim(name, 1)     ; on enleve les blancs en debut de ligne
-; on va mettre les elements du vecteur bout a bout pour former un
-; unique sring
+  name = strtrim(name, 1)       ; we remove blanks at the beginning of lines and 
+;                               we put elements of the vector stuck ones with 
+;                               each others to make an unique string.
   allnames = ''
   for i = 0, n_elements(name)-1 do allnames = allnames+name[i]
 ;
-  name = str_sep(allnames, '%') ; on le redecoupe 
-  name = strtrim(name, 2)     ; on eleve les blancs devant et derriere
-  name = strcompress(name)      ; on compresse les blancs
-; on ne retient pas les 2 premiers elements qui sont 1  un vide et la
-; ligne concernant routine_name 
+  name = str_sep(allnames, '%') ; we cut it out again. 
+  name = strtrim(name, 2)     ; we remouve blanks in front of and behind
+  name = strcompress(name)      ; we compress blanks
+; we do not hold back the two first elements who are a blanck  and the line concerning 
+; routine_name. 
   name = name[2: n_elements(name)-1]
-; on choisit la ligne qui nous concerne
-  if NOT keyword_set(remonte) then remonte = 0
-  if remonte GE n_elements(name) then return,  '$MAIN$'
-  name = name[remonte]
+; we choose the line which concern us.
+  if NOT keyword_set(pilingnum) then pilingnum = 0
+  if pilingnum GE n_elements(name) then return,  '$MAIN$'
+  name = name[pilingnum]
   if strpos(name, '$MAIN$') NE -1 then return,  '$MAIN$'
   name = str_sep(name, ' ')