Changeset 242 for trunk/SRC/Utilities/find.pro

Timestamp:

04/06/07 10:35:17 (17 years ago)

Author:

pinsard

Message:

improvements/corrections of some *.pro headers + replace some message by some report

File:

• trunk/SRC/Utilities/find.pro (modified) (7 diffs)

trunk/SRC/Utilities/find.pro

@@ -7 +7 @@
 ; By default look for files included in !path
 ;
-; all file_search keywords can be used.
+; all <proidl>file_search</proidl> keywords can be used.
 ;
 ; @categories
 ; find a file
 ;
-; @param FILEIN {in}{required}
-; A scalar or array variable of string type, containing
-; file names to match. Input names specifications may contain
+; @param FILEIN {in}{required} {type=scalar string or array of strings}
+; File name[s] to match. Input names specifications may contain
 ; wildcard characters, enabling them to match multiple files
-; (see file_search for more informations). By default and if
-; necessary, find is looking for filename and also for filename
+; (see <proidl>file_search</proidl> for more informations). By default and if
+; necessary, <pro>find</pro> is looking for filename and also for filename
 ; completed with '.pro'
 ;
@@ -23 +22 @@
 ; activate this keyword to stop looking for the file as soon as we found one.
 ;
-; @keyword IODIRECTORY {default=['.',!path]}
-; A scalar or array variable of string type, containing
-; directories names where we are looking for the file.
+; @keyword IODIRECTORY {type=scalar string or array of strings} {default=['.',!path]}
+; Directories names where we are looking for the file.
 ; Different directories can be separated by
 ; path_sep(/search_path) (':' on unix type machine) as it is done
@@ -47 +45 @@
 ; @keyword RECURSIVE
 ; performs recursive searching of directory hierarchies.
-; In a recursive search, find looks recursively for any and all
+; In a recursive search, <pro>find</pro> looks recursively for any and all
 ; subdirectories in the file hierarchy rooted at the IODIRECTORY argument.
 ;
 ; @keyword REPERTOIRE
-; obsolete. keep for compatibility, use directory keyword
+; obsolete. keep for compatibility, use IODIRECTORY keyword
 ;
 ; @keyword UNIQUE
@@ -57 +55 @@
 ;
 ; @keyword TRYFIND
-; if the file was not found and this keyword is activated, find will call
+; if the file was not found and this keyword is activated, <pro>find</pro> 
+; will call
 ; itself with the keywords /LOOKALLDIR and /FIRSTFOUND to try to find
 ; the file we are looking for. Note that if the file was found at the
@@ -68 +67 @@
 ; 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
+; exist with names matching the input arguments, <pro>find</pro> returns
 ; the scalar string : 'NOT FOUND'
 ;
 ; @examples
-;
 ; IDL> print, find('*loadct')
 ;   /usr/local/rsi/idl_6.0/lib/utilities/xloadct.pro
@@ -106 +104 @@
 ; @version
 ; $Id$
+;
 ;-
 ;
@@ -112 +111 @@
                , ONLYNC = onlync, UNIQUE = unique, FIRSTFOUND = firstfound $
                , LOOKALLDIR = LOOKALLDIR, TRYFIND = tryfind, _EXTRA = ex
-; define where we look for the file
 ;
   compile_opt idl2, strictarrsubs
 ;
+; define where we look for the file
   cd, current = current
   current = (file_search(current, /test_directory, /mark_directory))[0]