Changeset 142 for trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/STRING/tostr.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/STRING/tostr.html (modified) (4 diffs)

trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/STRING/tostr.html

@@ -696 +696 @@
       </div>
 
-      <div id="file_comments"></div>
+      <div id="file_comments">
+ Convert an input in a string.
+</div>
 
       
@@ -711 +713 @@
         <div class="routine_details" id="_tostr">
 
-          <h2><a class="top" href="#container">top</a>tostr </h2>
+          <h2><a class="top" href="#container">top</a>tostr <span class="categories"> 
+</span></h2>
         
           <p class="header">
@@ -717 +720 @@
         
           <div class="comments">
- NAME: tostr (to string)
-
- PURPOSE: convertit un input en un string.
-
- CATEGORY: 
-
- CALLING SEQUENCE: res=tostr(input)
- 
- INPUTS: input ne peut pas contenir ou etre de type:
+</div>
+
+          <h3>Return value</h3><div class="preformat">
+ a string
+</div>
+
+          
+            <h3>Parameters</h3>
+        
+            
+            <h4 id="_tostr_param_input">input&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+              <span class="attr">in</span>
+              
+              
+              <span class="attr">required</span>
+              
+              
+              
+              
+            </h4>
+        
+          <div class="comments">
+ input can not contain or be of the type of:
 
    Complex floating, structure, Double-precision complex, Pointer, Object
    reference, Unsigned Integer, Unsigned Longword Integer, 64-bit
    Integer, Unsigned 64-bit Integer     
-
- KEYWORD PARAMETERS: none
-
- OUTPUTS: un string
-
- COMMON BLOCKS:
-
- SIDE EFFECTS:
-
-   Si un element de input contient un tableau, il sera
-   convertit en vecteur.
-
- RESTRICTIONS:
-
-   attention cette fonction comporte des boucles, des if et des cases
-   ds tous les sens. Elle ne doit donc pas etre utilisee avec des
-   inputs de grosse taille (avec bcp d''elements et avec des
-   elements etant de gros tableaux).
- EXAMPLE:
+</div>
+            
+
+          
+
+          
+
+          <h3>Examples</h3><div class="preformat">
     IDL> help, tostr(1),tostr('a'),tostr(indgen(4)),tostr(['a','jkfjo'])
     <Expression>    STRING    = '1'
@@ -757 +763 @@
     ['c''est bon','c''est bon']
 </div>
-
-          
-
-          
-            <h3>Parameters</h3>
-        
-            
-            <h4 id="_tostr_param_input">input&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-              
-              
-              
-              
-              
-              
-              
-              
-            </h4>
-        
-          <div class="comments"></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">
+ If keywdvalue is an array, it will be convert in a vector.
+
+
+ Beware, this function has loops, ifs ad cases everywhere. So it can 
+ not be used by big keywords (with a lot of elements which are big 
+ arrays).
+ </div>