Changeset 93 for trunk/SRC/Utilities/find.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/find.pro (modified) (4 diffs)

trunk/SRC/Utilities/find.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:find
-;
-; PURPOSE: based on file_search, but it is possible to speficy
+; based on file_search, but it is possible to speficy
 ;          a set of possibles names and a different set of
 ;          possibles directories names.
 ;          By defaut look for files included in !path
 ;
-; CATEGORY:find a file
+; @categories find a file
 ;
-; CALLING SEQUENCE: found = find(filename)
-;
-; INPUTS: A scalar or array variable of string type, containing
+; @param filein {in}{required} A scalar or array variable of string type, containing
 ;     file names to match. Input names specifications may contain
 ;     wildcard characters, enabling them to match multiple files
@@ -21 +17 @@
 ;     completed with '.pro'
 ;
-; KEYWORD PARAMETERS:
-;
-;     FIRSTFOUND: activate this keyword to stop looking for the file as
+; @keyword FIRSTFOUND activate this keyword to stop looking for the file as
 ;        soon as we found one.
 ;
-;     IODIRECTORY: A scalar or array variable of string type, containing
+; @keyword IODIRECTORY A scalar or array variable of string type, containing
 ;        directories names where we are looking for the file. by defaut
 ;        we use !path. Different directories can be separated by
@@ -34 +28 @@
 ;        keyword is not taken into account.
 ;
-;     LOOKALLDIR:activate to look for the file with a recursive search
+; @keyword LOOKALLDIR activate to look for the file with a recursive search
 ;        in iodir, homedir, !path + the DATA:TestsData directory if it exists.
 ;
-;     NOPRO: activate to avoid the automatic search of filename
+; @keyword NOPRO activate to avoid the automatic search of filename
 ;        completed with '.pro'
 ;
-;     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. 
 ;
-;     REPERTOIRE: obsolete. keep for compatibility, use directory keyword
+; @keyword REPERTOIRE obsolete. keep for compatibility, use directory keyword
 ;
-;     UNIQUE: activate to make sure that each element of the output
+; @keyword UNIQUE activate to make sure that each element of the output
 ;        vector is unique.
 ;
-;     all file_search keywords
+; @file_comments  all file_search keywords can be used.
 ;
-; OUTPUTS: A scalar or array variable of string type, containing the
+; @returns A scalar or array variable of string type, containing the
 ;       name (with the full path of the matching files. If no files
 ;       exist with names matching the input arguments, find returns
 ;       the scalar string : 'NOT FOUND'
 ;
-; COMMON BLOCKS: none
-;
-; SIDE EFFECTS:
-;
-; RESTRICTIONS:
-;
-; EXAMPLE:
+; @examples 
 ;
 ;   IDL> print, find('*loadct')  
@@ -94 +82 @@
 ;   /usr/local/rsi/idl_6.0/lib/mesh_obj.pro
 ;
-; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history Sebastien Masson (smasson\@lodyc.jussieu.fr)
 ;                       28/4/1999
 ;                       6/7/1999: compatibilite mac et windows