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

trunk/SRC/Utilities/protype.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME: protype
-;
-; PURPOSE: test is a ".pro" file corresponds to an IDL procedure,
+; test is a ".pro" file corresponds to an IDL procedure,
 ;          function or batch file.
 ;
-; CATEGORY:
+; @categories utilities
 ;
-; CALLING SEQUENCE: type = protype(profilename)
-;
-; INPUTS: A scalar of string type, the name of the ".pro" file to be tested 
-;     if necessary, the input name is completed with '.pro'
+; @param file {in} A scalar of string type, the name of the ".pro" file to be tested
+;    if necessary, the input name is completed with '.pro'
 ;     and its path found in !path
 ;
-; KEYWORD PARAMETERS: NONE
+; @returns A scalar of string type: 'proc', 'func' or 'batch'
 ;
-; OUTPUTS: A scalar of string type: 'proc', 'func' or 'batch'
-;
-; COMMON BLOCKS: none
-;
-; SIDE EFFECTS:
-;
-; RESTRICTIONS:
-;
-; EXAMPLE:
+; @examples 
 ;
 ;      IDL> print, protype('protype')
@@ -37 +25 @@
 ;      proc
 ;
-; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history Sebastien Masson (smasson\@lodyc.jussieu.fr)
 ;                       Feb 2006
 ;-