Changeset 93 for trunk/SRC/Utilities/createpro.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/createpro.pro (modified) (2 diffs)

trunk/SRC/Utilities/createpro.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:createpro
+; write an idl procedure, compile it and execute it.
 ;
-; PURPOSE: write an idl procedure, compile it and execute it.
+; @param command {in}{required} a string array defining the procedure to be created. each element will be a line of the created procedure. 
 ;
-; CATEGORY:
-;
-; CALLING SEQUENCE:createpro, command
-; 
-; INPUTS:
-;      command: a string array defining the procedure to be created.
-;      each element will be a line of the created procedure. 
-;
-; KEYWORD PARAMETERS:
-;
-;      FILENAMEIN: name of the procedure to be created.
+; @keyword FILENAMEIN name of the procedure to be created.
 ;      'for_createpro.pro' by default
 ;
-;      KWDLIST: a vector string. to specify a list of keywords that
+; @keyword KWDLIST a vector string. to specify a list of keywords that
 ;      must be included in the procedure definition. Warning: the string
 ;      must start with a ',' for example: KWDLIST = ', TOTO = toto'
 ;
-;      _EXTRA: used to pass your keywords to the created procedure.
-;
-; OUTPUTS: none 
-;
-; COMMON BLOCKS: none
+; @keyword _EXTRA used to pass your keywords to the created procedure.
 ;
 ; SIDE EFFECTS: ends the procedure name with '.pro' if needed
 ;
-; RESTRICTIONS:is not working with functions, use createfunc instead.
+; @restrictions is not working with functions, use createfunc instead.
 ;              arguments can be given only through keywords
 ;
-; EXAMPLE:
+; @examples 
 ;      IDL> createpro, ['print,''OK'''], filename='test'
 ;      IDL> createpro, ['if keyword_set(ok) then print,''OK'' else print, ''No'''] $
@@ -43 +29 @@
 ;
 ;
-; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history Sebastien Masson (smasson\@lodyc.jussieu.fr)
 ; cleaning + new keywords: October 2005
 ; Feb. 2006: supress keyword "kwdused" and use call_procedure instead of execute