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

Timestamp:

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

Author:

navarro

Message:

english and nicer header (1)

File:

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

trunk/SRC/Utilities/xfile.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME: xfile
 ;
-; PURPOSE: affiche ds un widget un fichier ASCII.
-;          c''est la meme chose que xdisplaydife mais ici on l''utilise pour
-;          visualiser le contenu d''une procedure ou d''une fonction
-;          meme si elle n''est pas ds le repertoire courant (grace a !path)
+; @file_comments 
+; display in a widget an ASCII file.
+; It is the same thing that xdisplaydife but here, we use it 
+; to display the content of a procedure or of a function, 
+; even if it is not in the current directory (thanks to the path).
 ;
-; CATEGORY: help
+; @categories utilities
 ;
-; CALLING SEQUENCE: xfile,'nom_fichier'
+; @param filename {in}{required} It is the name of the procedure or of the function 
+;                    we want to display (with or without .pro at the end).
 ;
-; INPUTS:
-;        nom_fichier:le nom d''une procedure ou d''une fonction a
-;        visualiser avec ou sans le .pro a la fin
+; @keyword _extra used to pass your keywords
 ;
-; KEYWORD PARAMETERS:ceux de xdisplayfile
+; @examples xfile,'plt'
 ;
-; EXAMPLE:xfile,'plt'
-;
-; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history Sebastien Masson (smasson@lodyc.jussieu.fr)
 ;                       7/1/99
 ;                       6/7/1999: compatibilite mac et windows
+;
+; @version $Id$
+;
 ;-
 ;------------------------------------------------------------
@@ -35 +35 @@
 pfile = strlowcase(filename)
 ;
-; il faut trouver le nom complet 
+; we have to find the full name. 
 ;
    if strpos(pfile,".pro") lt 0 then pfile=pfile+".pro" 
@@ -57 +57 @@
    endrep until res[0] NE '' OR i EQ n_elements(pfile) 
    if res[0] NE  '' then BEGIN
-; on ouvre le fichier ds un widget
+; we open the file in a widget
    xdisplayfile, pfile[i-1], _extra = ex
    ENDIF ELSE ras = report('le fichier demande n''existe pas...')