Changeset 163 for trunk/SRC/Matrix/cmapply.pro

Timestamp:

08/29/06 14:59:46 (18 years ago)

Author:

navarro

Message:

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)

File:

• trunk/SRC/Matrix/cmapply.pro (modified) (6 diffs)

trunk/SRC/Matrix/cmapply.pro

@@ -2 +2 @@
 ; @file_comments
 ; Utility function, adapted from CMPRODUCT
+;
+; @param X
+;
 ;
 ; @version $Id$
@@ -28 +31 @@
 ; cmapply_redim : Utility function, used to collect collaped dimensions
 ;
+; @param newarr
+;
+;
+; @param dimapply
+;
+;
+; @param dimkeep
+;
+;
+; @param nkeep
+;
+;
+; @param totcol
+;
+;
+; @param totkeep
+;
+;
 ; @todo seb
 ;-
@@ -109 +130 @@
 ; Array
 ;
-; @param OP {in}{required}
+; @param OP {in}{required}{type=string}
 ; The operation to perform, as a string.  May be upper or lower case.
 ;
@@ -116 +137 @@
 ; the user-defined function.
 ;
-; @param ARRAY {in}{required}
+; @param ARRAY {in}{required}{type=array} 
 ; An array of values to be operated on.
 ; Must not be of type STRING (7) or STRUCTURE (8).
 ;
-; @param dimapply {in}{optional}{default=1 (ie, first dimension)}
+; @param dimapply {in}{optional}{default=1 (ie, first dimension)}{type=array}
 ; An array of dimensions that are to be "collapsed", where
 ; the the first dimension starts with 1 (ie, same convention
@@ -135 +156 @@
 ; precision (real or complex) then DOUBLE=1 is implied.
 ;
-; @keyword TYPE
+; @keyword TYPE {default=same as input type}
 ; Set this to the IDL code of the desired output type (refer
 ; to documentation of SIZE()).  Internal results will be
 ; rounded to the nearest integer if the output type is an
 ; integer type.
-; DEFAULT: same is input type
 ;
 ; @keyword FUNCTARGS
@@ -199 +219 @@
 ; @history Mar 1998, Written, CM
 ;   Changed usage message to not bomb, 24 Mar 2000, CM
-;   Signficant rewrite for *, MIN and MAX (inspired by Todd Clements
+;   Significant rewrite for *, MIN and MAX (inspired by Todd Clements
 ;     <Todd_Clements\@alumni.hmc.edu>); FOR loop indices are now type
 ;     LONG; copying terms are liberalized, CM, 22, Aug 2000