Changeset 142 for trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/LECTURE/inverse_binary.html

Timestamp:

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

Author:

navarro

Message:

english and nicer header (2a)

File:

• trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/LECTURE/inverse_binary.html (modified) (4 diffs)

trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/LECTURE/inverse_binary.html

@@ -696 +696 @@
       </div>
 
-      <div id="file_comments"></div>
+      <div id="file_comments">
+ Inverse function of the binary.pro function => given a
+ input array of 0/1, return its corresponding byte/integer/long
+ representation
+</div>
 
       
@@ -711 +715 @@
         <div class="routine_details" id="_inverse_binary">
 
-          <h2><a class="top" href="#container">top</a>inverse_binary </h2>
+          <h2><a class="top" href="#container">top</a>inverse_binary <span class="categories">
+</span></h2>
         
           <p class="header">
@@ -717 +722 @@
         
           <div class="comments">
- NAME: inverse_binary
-
- PURPOSE: inverse function of the binary.pro function => given a
- input array of 0/1, return its corresponding byte/integer/long
- representation
-
- CATEGORY:
-
- 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
+</div>
+
+          <h3>Return value</h3><div class="preformat"> 
+ A byte/integer/long array with (d1, d2...) dimensions
+</div>
+
+          
+            <h3>Parameters</h3>
+        
+            
+            <h4 id="_inverse_binary_param_binnumb">binnumb&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+              <span class="attr">in</span>
+              
+              
+              <span class="attr">required</span>
+              
+              
+              
+              
+            </h4>
+        
+          <div class="comments">
+ 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
-
- KEYWORD PARAMETERS: no
-
- OUTPUTS: a byte/integer/long array with (d1, d2...) dimensions
-
- COMMON BLOCKS: no
-
- RESTRICTIONS:the binary number can represent only byte/integer/long
-
- EXAMPLE:
+  (d1, d2...) are the output dimensions
+
+</div>
+            
+
+          
+
+          
+
+          <h3>Examples</h3><div class="preformat">
 
      IDL> a=indgen(5)
@@ -770 +785 @@
      IDL> print, inverse_binary(b)
             0       1       2       3       4
-
- MODIFICATION HISTORY:</div>
-
-          
-
-          
-            <h3>Parameters</h3>
-        
-            
-            <h4 id="_inverse_binary_param_binnumb">binnumb&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-              
-              
-              
-              
-              
-              
-              
-              
-            </h4>
-        
-          <div class="comments"></div>
-            
-
-          
-
-          
-
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
-          
+</div>
+          <h3>Version history</h3>
+          
+          <h4>Version</h4><div class="preformat">
+ $Id$
+</div>
+          <h4>History</h4><div class="preformat"></div>
+          
+          
+          <h3>Known issues</h3>
+          
+          
+          
+          <h4>Restrictions</h4><div class="preformat">
+ The binary number can represent only byte/integer/long
+</div>