Changeset 142 for trunk/SRC/ToBeReviewed/LECTURE/inverse_binary.pro

Timestamp:

07/21/06 14:47:49 (18 years ago)

Author:

navarro

Message:

english and nicer header (2a)

File:

• trunk/SRC/ToBeReviewed/LECTURE/inverse_binary.pro (modified) (2 diffs)

trunk/SRC/ToBeReviewed/LECTURE/inverse_binary.pro

@@ -1 +1 @@
 ;+
-; NAME: inverse_binary
 ;
-; PURPOSE: inverse function of the binary.pro function => given a
+; @file_comments
+; Inverse function of the binary.pro function => given a
 ; input array of 0/1, return its corresponding byte/integer/long
 ; representation
 ;
-; CATEGORY:
+; @categories
 ;
-; CALLING SEQUENCE: res = inverse_binary(binnum)
-;
-; INPUTS: 
-;    binnum must be a binary type array containing only 0 and 1.
-;    According to binary.pro outputs, binnum array must have the
-;    following dimensions values: (8, t, d1, d2...)
-;    t gives the output type: t = 1 -> byte
+; @param BINNUMB {in}{required}
+; Must be a binary type array containing only 0 and 1.
+; According to binary.pro outputs, binnum array must have the
+; following dimensions values: (8, t, d1, d2...)
+; t gives the output type: t = 1 -> byte
 ;                             t = 2 -> integer
 ;                             t = 4 -> long
 ;    
-;     (d1, d2...) are the output dimensions
+;  (d1, d2...) are the output dimensions
 ;
-; KEYWORD PARAMETERS: no
 ;
-; OUTPUTS: a byte/integer/long array with (d1, d2...) dimensions
+; @returns 
+; A byte/integer/long array with (d1, d2...) dimensions
 ;
-; COMMON BLOCKS: no
+; @restrictions
+; The binary number can represent only byte/integer/long
 ;
-; RESTRICTIONS:the binary number can represent only byte/integer/long
-;
-; EXAMPLE:
+; @examples
 ;
 ;     IDL> a=indgen(5)
@@ -54 +51 @@
 ;            0       1       2       3       4
 ;
-; MODIFICATION HISTORY:
+; @history
 ;      Sebastien Masson (smasson@jamstec.go.jp)
 ;      July 2004
+;
+; @version
+; $Id$
+;
 ;-
 ;------------------------------------------------------