Changeset 93 for trunk/SRC/Utilities/createfunc.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/createfunc.pro (modified) (1 diff)

trunk/SRC/Utilities/createfunc.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:createfunc
+; write an idl function, compile it and execute it.
+; usefull to avoid the use of execute
 ;
-; PURPOSE: 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 byven back by the function. (see examples)
 ;
-; CATEGORY:
-;
-; CALLING SEQUENCE:res = createfunc(command)
-; 
-; INPUTS:
-;      command: a scalar string defining the result to be byven back by the
-;               function. (see examples)
-;
-; KEYWORD PARAMETERS:
-;
-;      FILENAMEIN: name of the funccedure to be created.
+; @keyword FILENAMEIN {in} name of the funccedure to be created.
 ;      'for_createfunc.pro' by default
-;
-;      KWDLIST: a vector string. to specify a list of keywords that
+; @keyword KWDLIST {in} a vector string. to specify a list of keywords that
 ;      must be included in the function definition. Warning: the string
 ;      must start with a ',' for example: KWDLIST = ', TOTO = toto'
 ;
-;      _EXTRA: used to pass your keywords to the created function.
-;
-; OUTPUTS: none 
-;
-; COMMON BLOCKS: none
+; @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
+; @restrictions arguments can be given only through keywords
 ;
-; EXAMPLE:
+; @examples 
 ;      IDL> print, createfunc('3*2', filename='test')
 ;      IDL> print, createfunc('3*two', filename = 'test' $
 ;                                    , kwdlist ='two = two', two = 2)
 ;
-; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history Sebastien Masson (smasson\@lodyc.jussieu.fr)
 ;                      May 2005
 ;-