Changeset 223 for trunk/SRC/Utilities

Timestamp:

03/14/07 18:13:39 (17 years ago)

Author:

pinsard

Message:

improvements of some *.pro

Location:

trunk/SRC/Utilities

Files:

• protype.pro (modified) (2 diffs)
• xfile.pro (modified) (3 diffs)
• xhelp.pro (modified) (6 diffs)

trunk/SRC/Utilities/protype.pro

@@ -6 +6 @@
 ; test is a ".pro" file corresponds to an IDL procedure, function or batch file.
 ;
-; @categories 
+; @categories
 ; Utilities
 ;
-; @param FILE {in} 
-; A scalar of string type, the name of the ".pro" file to be tested
+; @param FILE {in}{required}{type=string}
+; the name of the ".pro" file to be tested.
 ; if necessary, the input name is completed with '.pro'
 ; and its path found in !path
 ;
-; @returns 
+; @returns
+; -1 if not found
 ; A scalar of string type: 'proc', 'func' or 'batch'
 ;
@@ -54 +55 @@
     ELSE:RETURN, 'batch'
   ENDCASE
- 
+
   RETURN, -1
 END

trunk/SRC/Utilities/xfile.pro

@@ -4 +4 @@
 ;+
 ;
-; @file_comments 
+; @file_comments
 ; display in a widget an ASCII file.
-; It is the same thing that xdisplayfile but here, we use it 
-; to display the content of a procedure or of a function, 
+; It is the same thing that xdisplayfile 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).
 ;
-; @categories 
+; @categories
 ; Utilities
 ;
-; @param FILENAME {in}{required} 
-; It is the name of the procedure or of the function 
+; @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).
 ;
-; @keyword _EXTRA 
+; @keyword _EXTRA
 ; used to pass your keywords
 ;
-; @examples xfile,'plt'
+; @examples
+; IDL> xfile,'plt'
 ;
-; @history Sebastien Masson (smasson\@lodyc.jussieu.fr)
-;                       7/1/99
-;                       6/7/1999: compatibility mac and windows
+; @history
+; Sebastien Masson (smasson\@lodyc.jussieu.fr)
+; 7/1/99
+; 6/7/1999: compatibility mac and windows
 ;
-; @version $Id$
+; @version
+; $Id$
 ;
 ;-
@@ -38 +41 @@
 pfile = strlowcase(filename)
 ;
-; we have to find the full name. 
+; we have to find the full name.
 ;
-   if strpos(pfile,".pro") lt 0 then pfile=pfile+".pro" 
+   if strpos(pfile,".pro") lt 0 then pfile=pfile+".pro"
    thisOS = strupcase(strmid(!version.os_family, 0, 3))
    CASE thisOS of
@@ -56 +59 @@
    i = 0
    repeat begin
-      res = findfile(pfile[i]) 
+      res = findfile(pfile[i])
       i = i+1
-   endrep until res[0] NE '' OR i EQ n_elements(pfile) 
+   endrep until res[0] NE '' OR i EQ n_elements(pfile)
    if res[0] NE  '' then BEGIN
 ; we open the file in a widget
    xdisplayfile, pfile[i-1], _extra = ex
-   ENDIF ELSE ras = report('le fichier demande n''existe pas...')
+   ENDIF ELSE ras = report('file does not exist ...')
 ;
 ;

trunk/SRC/Utilities/xhelp.pro

@@ -1 +1 @@
 ;+
 ;
-; @file_comments 
+; @file_comments
 ; Display an IDL procedure header using widgets and the widget manager.
 ;
@@ -7 +7 @@
 ; Widget
 ;
-; @param FILENAME {in}{required} 
-; A scalar string that contains the filename of the file to display.  
-; If FILENAME does not include a complete path specification, xhelp will 
+; @param FILENAME {in}{required}
+; A scalar string that contains the filename of the file to display.
+; If FILENAME does not include a complete path specification, xhelp will
 ; search for the file in the current working directory and then each of the
 ; directories listed in !PATH environment variable.  The
 ; ".pro" file suffix will be appended if it is not supplied.
 ;
-; @keyword _EXTRA 
+; @keyword _EXTRA
 ; used to pass your keywords
 ;
-; @restrictions 
+; @restrictions
 ; Triggers the XMANAGER if it is not already in use.
 ;
-; @examples 
-; Open a file and create a widget to display its contents.
+; @examples
+; IDL> xhelp,'plt'
 ;
-; @history Written By Steve Richards, December 1990
+; @history
+; Written By Steve Richards, December 1990
 ;       Graceful error recovery, DMS, Feb, 1992.
 ;       Modified to extract .pro documentation headers, PJR/ESRG mar94
@@ -33 +34 @@
 ;  6/7/1999: compatibility mac and windows
 ;
-; @version $Id$
+; @version
+; $Id$
 ;
 ;-
@@ -47 +49 @@
       return
    endif
-; We have to find the full name 
+; We have to find the full name
    pfile=FILENAME
-   if strpos(pfile,".pro") lt 0 then pfile=pfile+".pro" 
+   if strpos(pfile,".pro") lt 0 then pfile=pfile+".pro"
    thisOS = strupcase(strmid(!version.os_family, 0, 3))
    CASE thisOS of
@@ -67 +69 @@
    n = 0
    repeat begin
-      res = findfile(pfile[n]) 
+      res = findfile(pfile[n])
       n = n+1
-   endrep until res[0] NE '' OR n EQ n_elements(pfile) 
+   endrep until res[0] NE '' OR n EQ n_elements(pfile)
    if res[0] NE '' then BEGIN
       openr, unit,pfile[n-1], /get_lun ; opening of the file
-; we select the heading piece     
+; we select the heading piece
       a = strarr(1000)          ;Maximum # of lines
       xsize=0
@@ -90 +92 @@
       endwhile
       if i EQ 0 then $
-         ras = report('le programme a etait mal ecrit, il n''y a pas d''en-tete... utiliser xfile.pro.') ELSE BEGIN 
+         ras = report('le programme a etait mal ecrit, il n''y a pas d''en-tete... utiliser xfile.pro.') ELSE BEGIN
          a = a[0:i-1]
 ; we wrote the a's content in a widget
          xdisplayfile,'toto',text = a,title=pfile[n-1], _extra = ex
-      ENDELSE 
+      ENDELSE
       FREE_LUN, unit         ;free the file unit.
    ENDIF ELSE ras = report('le fichier demande n''existe pas...')