Changeset 373 for trunk/SRC/Matrix/zero_one.pro

Timestamp:

08/08/08 16:11:31 (16 years ago)

Author:

pinsard

Message:

improvements of headers (examples and results)

File:

• trunk/SRC/Matrix/zero_one.pro (modified) (1 diff)

trunk/SRC/Matrix/zero_one.pro

@@ -6 +6 @@
 ; Matrix
 ;
-; @param n1 {in}{required}
+; @param n1 {in}{required} {type=integer}
 ; number of elements in the first dimension
 ;
-; @param n2 {in}{required}
+; @param n2 {in} {type=integer}
 ; number of elements in the second dimension
 ;
+; @examples
+;
+;   IDL> a=zero_one(3)   
+;   IDL> help,a
+;   A               FLOAT     = Array[3]
+;   IDL> print,a
+;         0.00000      1.00000      0.00000
+;
+;   IDL> a=zero_one(2,3)   
+;   IDL> help,a
+;   A               FLOAT     = Array[2, 3]
+;   IDL> print,a
+;      0.00000      1.00000
+;      1.00000      0.00000
+;      0.00000      1.00000
+;
 ; @returns
-; result
+; an array of n1 dimension or n1xn2 dimensions
 ;
 ; @history