Changeset 121 for trunk/SRC/Utilities

Timestamp:

06/29/06 16:59:33 (18 years ago)

Author:

pinsard

Message:

correction of some *.pro using aspell list; introduction of default idldoc syntax

Location:

trunk/SRC/Utilities

Files:

• createfunc.pro (modified) (1 diff)
• createpro.pro (modified) (3 diffs)
• find.pro (modified) (4 diffs)
• isafile.pro (modified) (1 diff)

trunk/SRC/Utilities/createfunc.pro

@@ -9 +9 @@
 ; given back by the function. (see examples)
 ;
-; @keyword FILENAMEIN {in} name of the funccedure to be created.
-;      'for_createfunc.pro' by default
+; @keyword FILENAMEIN {in} {default=for_createfunc.pro} 
+; name of the function to be created.
 ;
 ; @keyword KWDLIST {in} a vector string. to specify a list of keywords that

trunk/SRC/Utilities/createpro.pro

@@ -7 +7 @@
 ; @param command {in}{required} a string array defining the procedure to be created. each element will be a line of the created procedure.
 ;
-; @keyword FILENAMEIN {in} name of the procedure to be created.
-;      'for_createpro.pro' by default
+; @keyword FILENAMEIN {in} {default=for_createpro.pro}
+;  name of the procedure to be created.
 ;
 ; @keyword KWDLIST {in} a vector string. to specify a list of keywords that
@@ -14 +14 @@
 ;      must start with a ',' for example: KWDLIST = ', TOTO = toto'
 ;
-; @keyword KWDUSED obsolote, please pass directly your keywords through _extra
+; @keyword KWDUSED obsolote, please pass directly your keywords through _EXTRA
 ;
 ; @keyword _EXTRA used to pass your keywords to the created procedure.
@@ -41 +41 @@
 ;------------------------------------------------------------
 PRO createpro, command, FILENAMEIN = filenamein $
-               , KWDLIST = kwdlist, KWDUSED = kwdused, _extra = ex
+               , KWDLIST = kwdlist, KWDUSED = kwdused, _EXTRA = ex
 ;
   compile_opt idl2, hidden, strictarrsubs

trunk/SRC/Utilities/find.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; @file_comments based on file_search, but it is possible to speficy
+; @file_comments based on file_search, but it is possible to specify
 ;          a set of possibles names and a different set of
 ;          possibles directories names.
-;          By defaut look for files included in !path
+;          By default look for files included in !path
 ;
 ; @categories find a file
@@ -13 +13 @@
 ;     file names to match. Input names specifications may contain
 ;     wildcard characters, enabling them to match multiple files
-;     (see file_search for more informations). By defaut and if
+;     (see file_search for more informations). By default and if
 ;     necessary, find is looking for filename and also for filename
 ;     completed with '.pro'
@@ -20 +20 @@
 ;        soon as we found one.
 ;
-; @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
+; @keyword IODIRECTORY {default=!path} A scalar or array variable of string type, containing
+;        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
 ;        to define !path.
@@ -86 +86 @@
 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr)
 ;                       28/4/1999
-;                       6/7/1999: compatibilite mac et windows
+;                       6/7/1999: compatibility mac and windows
 ; June 2005: Sebastien Masson: cleaning, use for file_* functions
 ;

trunk/SRC/Utilities/isafile.pro

@@ -16 +16 @@
 ;
 ; @keyword IODIRECTORY a directory where we look for the file. this
-;           keyword is taken into account only if the dirmame
+;           keyword is taken into account only if the dirname
 ;           of filein or filename is '.'
 ;
-; @keyword /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
 ;