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

Timestamp:

07/06/06 16:32:02 (18 years ago)

Author:

pinsard

Message:

improvements of Utilities/*.pro header

File:

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

trunk/SRC/Utilities/createfunc.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; @file_comments write an idl function, compile it and execute it.
+; @file_comments
+; write an idl function, compile it and execute it.
 ; usefull to avoid the use of execute
 ;
-; @param command {in}{required} a scalar string defining the result to be 
+; @param command {in}{required} a scalar string defining the result to be
 ; given back by the function. (see examples)
 ;
-; @keyword FILENAMEIN {in} {default=for_createfunc.pro} 
+; @keyword FILENAMEIN {in} {default=for_createfunc.pro}
 ; name of the function to be created.
 ;
@@ -18 +19 @@
 ; @keyword _EXTRA used to pass your keywords to the created function.
 ;
-; @restrictions 
+; @restrictions
 ; - arguments can be given only through keywords;
 ; - ends the function name with '.pro' if needed.
 ;
 ; @examples
-;      IDL> print, createfunc('3*2', filename='test')
-;      IDL> print, createfunc('3*two', filename = 'test' $
-;                                    , kwdlist ='two = two', two = 2)
+; IDL> print, createfunc('3*2', filename='test')
+; IDL> print, createfunc('3*two', filename = 'test' $
+; IDL>                          , kwdlist ='two = two', two = 2)
 ;
 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr)