Changeset 102 for trunk/SRC/Documentation/idldoc_html_output/ForOldVersion

Timestamp:

06/12/06 11:20:31 (18 years ago)

Author:

pinsard

Message:

start to modify headers of ForOldVersion? *.pro files for better idldoc output

Location:

trunk/SRC/Documentation/idldoc_html_output/ForOldVersion

Files:

• directory-overview.html (modified) (1 diff)
• keep_compatibility.html (modified) (5 diffs)

trunk/SRC/Documentation/idldoc_html_output/ForOldVersion/directory-overview.html

@@ -90 +90 @@
       
         <dt><a href="keep_compatibility.html?format=raw">keep_compatibility.pro</a></dt>
-        <dd></dd>
+        <dd>     1) define key_forgetold = 1b - keyword_set(flag)    2) remove all oldcm_used.</dd>
       
         <dt><a href="oldcm_empty.html?format=raw">oldcm_empty.pro</a></dt>

trunk/SRC/Documentation/idldoc_html_output/ForOldVersion/keep_compatibility.html

@@ -87 +87 @@
       </div>
 
-      <div id="file_comments"></div>
+      <div id="file_comments"> 
+   1) define key_forgetold = 1b - keyword_set(flag)
+   2) remove all oldcm_used.pro found in !path
+   3) define and create myuniquetmpdir and add it to !path
+   4) copy oldcm_full(_empty) to myuniquetmpdir+'oldcm_used.pro'
+</div>
 
       
@@ -102 +107 @@
         <div class="routine_details" id="_keep_compatibility">
 
-          <h2><a class="top" href="#container">top</a>keep_compatibility </h2>
+          <h2><a class="top" href="#container">top</a>keep_compatibility <span class="categories"> compatibility with old version
+</span></h2>
         
           <p class="header">
-            keep_compatibility<span class="result">, <a href="#_keep_compatibility_param_flag">flag</a></span></p>
+            keep_compatibility<span class="result">[, <a href="#_keep_compatibility_param_flag">flag</a>]</span></p>
         
-          <div class="comments">
- NAME: keep_compatibility
-
- PURPOSE: 
-   1) define key_forgetold = 1b - keyword_set(flag)
-   2) remove all oldcm_used.pro found in !path
-   3) define and create myuniquetmpdir and add it to !path
-   4) copy oldcm_full(_empty) to myuniquetmpdir+'oldcm_used.pro'
-
- CATEGORY: compatibility with old version
-
- CALLING SEQUENCE:keep_compatibility [, flag]
-
- INPUTS: 
-
-    flag: 1 or 0 to keep or forget the compatibility
-    dir: the directory where we create oldcm_used.pro.
-    if omitted, is automatically defined to 
-             1b - keyword_set(key_forgetold) 
-
- COMMON BLOCKS: cm_general
-
- SIDE EFFECTS: see purpose
-
- RESTRICTIONS: copy oldcm_full or oldcm_empty must be found in the
- !path. dir must aslo be in the !path
-</div>
+          <div class="comments"></div>
 
           
@@ -142 +122 @@
             
             <h4 id="_keep_compatibility_param_flag">flag&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+              <span class="attr">in</span>
               
-              
-              
+              <span class="attr">optional</span>
               
               
@@ -152 +132 @@
             </h4>
         
-          <div class="comments"></div>
+          <div class="comments"> 1 or 0 to keep or forget the compatibility
+
+ uses cm_general
+</div>
             
 
@@ -159 +142 @@
           
 
+          <h3>Examples</h3><div class="value">
+ IDL> keep_compatibility [, flag]
+</div>
+          <h3>Version history</h3>
+          
+          
+          <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr)
+                      June 2005
+</div>
+          
+          
+          <h3>Known issues</h3>
           
           
           
-          
-          
-          
-          
-          
-          
-          
-          
-          
+          <h4>Restrictions</h4><div class="value"> copy oldcm_full or oldcm_empty must be found in the
+ !path. dir must also be in the !path
+</div>