Changeset 93 for trunk/SRC/Utilities/isafile.pro

Timestamp:

06/07/06 19:12:14 (18 years ago)

Author:

pinsard

Message:

start to modify headers of Calendar and Utilities *.pro files for bet
ter idldoc output

File:

• trunk/SRC/Utilities/isafile.pro (modified) (2 diffs)

trunk/SRC/Utilities/isafile.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME: isafile
-;
-; PURPOSE: same as find.pro except that as long as the file is 'NOT FOUND',
+; same as find.pro except that as long as the file is 'NOT FOUND',
 ;          isafile calls dialog_pickfile, to ask the user to select a file.
 ;
-; CATEGORY: io
+; @categories io
 ;
-; CALLING SEQUENCE:filename = isafile([filein])
 ; 
-; INPUTS:optional:a proposed name. If neither filein
+; @param filein {in}{optional} a proposed name. If neither filein
 ;        input parameter of filename keyword are defined,
 ;        the ask the user to choose a file.
 ;
-; KEYWORD PARAMETERS:
+; @keyword FILENAME a proposed filename.
 ;
-;     FILENAME: a proposed filename.
-;
-;     IODIRECTORY: a directory where we look for the file. this
+; @keyword IODIRECTORY a directory where we look for the file. this
 ;           keyword is taken into account only if the dirmame
 ;           of filein or filename is '.'
 ;
-;     /NEW:to specify that filename is a new file and that
+; @keyword /NEW to specify that filename is a new file and that
 ;        we should check only its path
 ;
-;     ONLYPRO:force to look only at file ending with .pro
+; @keyword ONLYPRO force to look only at file ending with .pro
 ;
-;     ONLYNC:force to look only at file ending with .nc
+; @keyword ONLYNC force to look only at file ending with .nc
 ;
-;     RECURSIVE: performs recursive searching of directory hierarchies.
+; @keyword RECURSIVE performs recursive searching of directory hierarchies.
 ;        In a recursive search, find looks recursively for any and all 
 ;        subdirectories in the file hierarchy rooted at the IODIRECTORY
 ;        argument. 
 ;
-;     all find, file_search and dialog_pickfile keywords (like title)
+; @file_comments all find, file_search and dialog_pickfile keywords (like title)
+can be used
 ;
-; OUTPUTS:the filename with its path
+; @returns the filename with its path
 ;
-; COMMON BLOCKS:none
-;
-; SIDE EFFECTS:
-;
-; RESTRICTIONS:
-;
-; EXAMPLE:
+; @examples 
 ;
 ;  IDL> print, isafile('/Users/sebastie/SAXO_RD/Commons/cm_4mesh.pro')
@@ -60 +50 @@
 ;  IDL> print, isafile('fake_file.pro')
 ;
-; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history Sebastien Masson (smasson\@lodyc.jussieu.fr)
 ;                      11/2/2000
 ; June 2005: Sebastien Masson: cleaning, use for file_* functions