Changeset 118 for trunk/SRC/Utilities/createfunc.pro

Timestamp:

06/27/06 17:47:06 (18 years ago)

Author:

pinsard

Message:

add $ in Calendar, Grid, Interpolation, Obsolete and Postscript *.pro files, add svn:keywords Id to all these files, some improvements in header

File:

• trunk/SRC/Utilities/createfunc.pro (modified) (7 diffs, 1 prop)

trunk/SRC/Utilities/createfunc.pro

@@ -6 +6 @@
 ; usefull to avoid the use of execute
 ;
-; @param command {in}{required} a scalar string defining the result to be byven back by the function. (see examples)
+; @param command {in}{required} a scalar string defining the result to be 
+; given back by the function. (see examples)
 ;
 ; @keyword FILENAMEIN {in} name of the funccedure to be created.
 ;      'for_createfunc.pro' by default
+;
 ; @keyword KWDLIST {in} a vector string. to specify a list of keywords that
 ;      must be included in the function definition. Warning: the string
@@ -16 +18 @@
 ; @keyword _EXTRA used to pass your keywords to the created function.
 ;
-; SIDE EFFECTS: ends the function name with '.pro' if needed
+; @restrictions 
+; - arguments can be given only through keywords;
+; - ends the function name with '.pro' if needed.
 ;
-; @restrictions arguments can be given only through keywords
-;
-; @examples 
+; @examples
 ;      IDL> print, createfunc('3*2', filename='test')
 ;      IDL> print, createfunc('3*two', filename = 'test' $
@@ -27 +29 @@
 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr)
 ;                      May 2005
+;
+; @version $Id$
+;
 ;-
 ;------------------------------------------------------------
@@ -32 +37 @@
 ;------------------------------------------------------------
 FUNCTION createfunc, command, FILENAMEIN = filenamein $
-               , KWDLIST = kwdlist, _extra = ex
+               , KWDLIST = kwdlist, _EXTRA = ex
 ;
   compile_opt idl2, hidden, strictarrsubs
@@ -39 +44 @@
 ; define filename if needed
   if NOT keyword_set(filenamein) then filename = 'for_createfunc.pro' $
-  ELSE filename = filenamein 
+  ELSE filename = filenamein
 ; get the name of the function (not the name of the file containing the function)
    shortfilename =  file_basename(filename, '.pro')
@@ -50 +55 @@
 ; create the file
    if NOT keyword_set(kwdlist) then kwdlist = ''
-   kwdlist = kwdlist + ', _extra = ex'
+   kwdlist = kwdlist + ', _EXTRA = ex'
    IF strmid(kwdlist, 0, 1) NE ',' THEN kwdlist = ', ' +  kwdlist
    putfile, filename, ['function ' + shortfilename + kwdlist $
@@ -63 +68 @@
    cd, old_dir
 ; execute it
-   res = call_function(shortfilename, _extra = ex)
+   res = call_function(shortfilename, _EXTRA = ex)
 ;
    return, res