Changeset 102


Ignore:
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
Files:
13 edited

Legend:

Unmodified
Added
Removed

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

    r89 r102  
    9090       
    9191        <dt><a href="keep_compatibility.html?format=raw">keep_compatibility.pro</a></dt> 
    92         <dd></dd> 
     92        <dd>     1) define key_forgetold = 1b - keyword_set(flag)    2) remove all oldcm_used.</dd> 
    9393       
    9494        <dt><a href="oldcm_empty.html?format=raw">oldcm_empty.pro</a></dt> 

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

    r89 r102  
    8787      </div> 
    8888 
    89       <div id="file_comments"></div> 
     89      <div id="file_comments">  
     90   1) define key_forgetold = 1b - keyword_set(flag) 
     91   2) remove all oldcm_used.pro found in !path 
     92   3) define and create myuniquetmpdir and add it to !path 
     93   4) copy oldcm_full(_empty) to myuniquetmpdir+'oldcm_used.pro' 
     94</div> 
    9095 
    9196       
    … …  
    102107        <div class="routine_details" id="_keep_compatibility"> 
    103108 
    104           <h2><a class="top" href="#container">top</a>keep_compatibility </h2> 
     109          <h2><a class="top" href="#container">top</a>keep_compatibility <span class="categories"> compatibility with old version 
     110</span></h2> 
    105111         
    106112          <p class="header"> 
    107             keep_compatibility<span class="result">, <a href="#_keep_compatibility_param_flag">flag</a></span></p> 
     113            keep_compatibility<span class="result">[, <a href="#_keep_compatibility_param_flag">flag</a>]</span></p> 
    108114         
    109           <div class="comments"> 
    110  NAME: keep_compatibility 
    111  
    112  PURPOSE:  
    113    1) define key_forgetold = 1b - keyword_set(flag) 
    114    2) remove all oldcm_used.pro found in !path 
    115    3) define and create myuniquetmpdir and add it to !path 
    116    4) copy oldcm_full(_empty) to myuniquetmpdir+'oldcm_used.pro' 
    117  
    118  CATEGORY: compatibility with old version 
    119  
    120  CALLING SEQUENCE:keep_compatibility [, flag] 
    121  
    122  INPUTS:  
    123  
    124     flag: 1 or 0 to keep or forget the compatibility 
    125     dir: the directory where we create oldcm_used.pro. 
    126     if omitted, is automatically defined to  
    127              1b - keyword_set(key_forgetold)  
    128  
    129  COMMON BLOCKS: cm_general 
    130  
    131  SIDE EFFECTS: see purpose 
    132  
    133  RESTRICTIONS: copy oldcm_full or oldcm_empty must be found in the 
    134  !path. dir must aslo be in the !path 
    135 </div> 
     115          <div class="comments"></div> 
    136116 
    137117           
    … …  
    142122             
    143123            <h4 id="_keep_compatibility_param_flag">flag&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     124              <span class="attr">in</span> 
    144125               
    145                
    146                
     126              <span class="attr">optional</span> 
    147127               
    148128               
    … …  
    152132            </h4> 
    153133         
    154           <div class="comments"></div> 
     134          <div class="comments"> 1 or 0 to keep or forget the compatibility 
     135 
     136 uses cm_general 
     137</div> 
    155138             
    156139 
    … …  
    159142           
    160143 
     144          <h3>Examples</h3><div class="value"> 
     145 IDL> keep_compatibility [, flag] 
     146</div> 
     147          <h3>Version history</h3> 
     148           
     149           
     150          <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr) 
     151                      June 2005 
     152</div> 
     153           
     154           
     155          <h3>Known issues</h3> 
    161156           
    162157           
    163158           
    164            
    165            
    166            
    167            
    168            
    169            
    170            
    171            
    172            
     159          <h4>Restrictions</h4><div class="value"> copy oldcm_full or oldcm_empty must be found in the 
     160 !path. dir must also be in the !path 
     161</div> 
    173162         
    174163           

  • trunk/SRC/Documentation/idldoc_html_output/idldoc-categories.html

    r101 r102  
    156156             
    157157          </ul> 
     158        </li>        <li id="idldoc-compatibility_with_old_version">compatibility with old version <span class="result">(1 routine)</span> 
     159          <ul> 
     160             
     161            <li><a href="./ForOldVersion/keep_compatibility.html?format=raw#_keep_compatibility">keep_compatibility</a></li> 
     162             
     163          </ul> 
    158164        </li>        <li id="idldoc-find_a_file">find a file <span class="result">(1 routine)</span> 
    159165          <ul> 

  • trunk/SRC/Documentation/idldoc_html_output/idldoc-warnings.html

    r101 r102  
    149149</tr> 
    150150 
    151 </table><a href="./ForOldVersion/keep_compatibility.html?format=raw">./ForOldVersion/keep_compatibility.pro</a> 
    152 <table> 
    153  
    154 <tr> 
    155 <td class="docroutine"><a href="./ForOldVersion/keep_compatibility.html?format=raw#_keep_compatibility">keep_compatibility</a></td> 
    156 <td class="docstat partialdoc">partially documented</td> 
    157 </tr> 
    158  
    159151</table><a href="./Grid/computegrid.html?format=raw">./Grid/computegrid.pro</a> 
    160152<table> 

  • trunk/SRC/Documentation/idldoc_html_output/overview.html

    r101 r102  
    360360        <tr> 
    361361          <td>Lines of code</td> 
    362           <td class="value">       55663</td> 
     362          <td class="value">       55655</td> 
    363363        </tr> 
    364364      </table> 

  • trunk/SRC/Documentation/idldoc_html_output/search.js

    r101 r102  
    1515a[13] = new Array("./Commons/cm_general.html", "cm_general.pro", "", ""); 
    1616a[14] = new Array("./Documentation/xmldoc/idlfiles/init_example.html", "init_example.pro", "", ""); 
    17 a[15] = new Array("./ForOldVersion/keep_compatibility.html", "keep_compatibility.pro", "", "    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     MODIFICATION HISTORY:Sebastien Masson  smasson lodyc jussieu fr                         June 2005     PRO keep_compatibility  flag    cm_general     version should be at least 6 0     IF fix strmid version release  0  1  LT 6 THEN BEGIN      print                                print                        ERROR       print                                print   This version of SAXO needs at least IDL version 6 0      print                                print                        ERROR       print                                return   ENDIF     IF n_elements myuniquetmpdir  NE 0 THEN BEGIN      path    path   :    expand_path myuniquetmpdir      return   ENDIF      if n_elements flag  eq 0 then flag   1b   keyword_set key_forgetold     1  automatic definition of key_forgetold   key_forgetold   1b   keyword_set flag       2  remove all oldcm_used pro found in  path   to_rm   find oldcm_used    IF to_rm 0  NE  NOT FOUND  THEN file_delete  to_rm     3  define and create myuniquetmpdir and add it to  path   def_myuniquetmpdir     4  copy oldcm_full _empty  to myuniquetmpdir oldcm_used pro    select which file should be copied to oldcm_used pro   IF key_forgetold THEN BEGIN      oldcm   find oldcm_empty      print   We forget the compatibility with the old version    ENDIF ELSE BEGIN      oldcm   find oldcm_full       print   We keep the compatibility with the old version    ENDELSE      oldcm   oldcm 0    IF oldcm EQ  NOT FOUND  THEN BEGIN     print   Error: oldcm_full or oldcm_empty must be found in the  path      stop   ENDIF   copy   file_copy  oldcm  myuniquetmpdir    oldcm_used pro   overwrite     make sure we can make the plots enev if we are using the demo mode     demomode_compatibility      make sure that the common variables are correctly initialized      IF size ccmeshparameters   type  NE 8 THEN BEGIN      computegrid  1  1  1  1  1  1   fullcgrid  cm_4data         varname         vargrid    T      vardate    0      varexp         varunit         valmask   1 e20   ENDIF       return END"); 
     17a[15] = new Array("./ForOldVersion/keep_compatibility.html", "keep_compatibility.pro", "", "     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       categories compatibility with old version      examples   IDL  keep_compatibility   flag       param flag  in optional  1 or 0 to keep or forget the compatibility     uses cm_general      restrictions copy oldcm_full or oldcm_empty must be found in the    path  dir must also be in the  path      history Sebastien Masson  smasson lodyc jussieu fr                         June 2005     PRO keep_compatibility  flag    cm_general     version should be at least 6 0     IF fix strmid version release  0  1  LT 6 THEN BEGIN      print                                print                        ERROR       print                                print   This version of SAXO needs at least IDL version 6 0      print                                print                        ERROR       print                                return   ENDIF     IF n_elements myuniquetmpdir  NE 0 THEN BEGIN      path    path   :    expand_path myuniquetmpdir      return   ENDIF      if n_elements flag  eq 0 then flag   1b   keyword_set key_forgetold     1  automatic definition of key_forgetold   key_forgetold   1b   keyword_set flag       2  remove all oldcm_used pro found in  path   to_rm   find oldcm_used    IF to_rm 0  NE  NOT FOUND  THEN file_delete  to_rm     3  define and create myuniquetmpdir and add it to  path   def_myuniquetmpdir     4  copy oldcm_full _empty  to myuniquetmpdir oldcm_used pro    select which file should be copied to oldcm_used pro   IF key_forgetold THEN BEGIN      oldcm   find oldcm_empty      print   We forget the compatibility with the old version    ENDIF ELSE BEGIN      oldcm   find oldcm_full       print   We keep the compatibility with the old version    ENDELSE      oldcm   oldcm 0    IF oldcm EQ  NOT FOUND  THEN BEGIN     print   Error: oldcm_full or oldcm_empty must be found in the  path      stop   ENDIF   copy   file_copy  oldcm  myuniquetmpdir    oldcm_used pro   overwrite     make sure we can make the plots enev if we are using the demo mode     demomode_compatibility      make sure that the common variables are correctly initialized      IF size ccmeshparameters   type  NE 8 THEN BEGIN      computegrid  1  1  1  1  1  1   fullcgrid  cm_4data         varname         vargrid    T      vardate    0      varexp         varunit         valmask   1 e20   ENDIF       return END"); 
    1818a[16] = new Array("./ForOldVersion/oldcm_empty.html", "oldcm_empty.pro", "", ""); 
    1919a[17] = new Array("./ForOldVersion/oldcm_full.html", "oldcm_full.pro", "", ""); 

  • trunk/SRC/ForOldVersion/keep_compatibility.pro

    r76 r102  
    11;+ 
    2 ; NAME: keep_compatibility 
    3 ; 
    4 ; PURPOSE:  
     2; @file_comments  
    53;   1) define key_forgetold = 1b - keyword_set(flag) 
    64;   2) remove all oldcm_used.pro found in !path 
    … …  
    86;   4) copy oldcm_full(_empty) to myuniquetmpdir+'oldcm_used.pro' 
    97; 
    10 ; CATEGORY: compatibility with old version 
     8; @categories compatibility with old version 
    119; 
    12 ; CALLING SEQUENCE:keep_compatibility [, flag] 
     10; @examples 
     11; IDL> keep_compatibility [, flag] 
    1312; 
    14 ; INPUTS:  
     13; @param flag {in}{optional} 1 or 0 to keep or forget the compatibility 
    1514; 
    16 ;    flag: 1 or 0 to keep or forget the compatibility 
    17 ;    dir: the directory where we create oldcm_used.pro. 
    18 ;    if omitted, is automatically defined to  
    19 ;             1b - keyword_set(key_forgetold)  
     15; uses cm_general 
    2016; 
    21 ; COMMON BLOCKS: cm_general 
     17; @restrictions copy oldcm_full or oldcm_empty must be found in the 
     18; !path. dir must also be in the !path 
    2219; 
    23 ; SIDE EFFECTS: see purpose 
    24 ; 
    25 ; RESTRICTIONS: copy oldcm_full or oldcm_empty must be found in the 
    26 ; !path. dir must aslo be in the !path 
    27 ; 
    28 ; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr) 
     20; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    2921;                      June 2005 
    3022; 

  • trunk/SRC/ForOldVersion/oldcm_empty.pro

    r55 r102  
    11;+ 
    22; 
    3 ; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr) 
     3; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    44;                       June 2005 
    55;- 

  • trunk/SRC/ForOldVersion/oldcm_full.pro

    r55 r102  
    11;+ 
    22; 
    3 ; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr) 
     3; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    44;                       14/8/98 
    55;- 

  • trunk/SRC/ForOldVersion/updatekwd.pro

    r55 r102  
    11;+ 
    2 ; NAME: updatekwd 
    32; 
    4 ; PURPOSE: compatibility with old keywords 
     3; @file_comments  
     4; compatibility with old keywords 
     5; if needed, force the definition of new keywords 
     6;               with the old ones. 
    57; 
    6 ; CATEGORY: compatibility with previous version 
     8; @categories compatibility with previous version 
    79; 
    8 ; CALLING SEQUENCE: @updatekwd 
     10; @examples  
     11; IDL> \@updatekwd 
    912;   (must be insert as an include in a procedure or function)  
    1013; 
    11 ; SIDE EFFECTS: if needed, force the definition of new keywords 
    12 ;               with the old ones. 
    1314; 
    14 ; RESTRICTIONS: the compatibility can be made only if the keyword 
     15; @restrictions the compatibility can be made only if the keyword 
    1516;               given through _extra are given with their complete name 
    1617; 
    17 ; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr) 
     18; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    1819;                      July 2005 
    1920;- 

  • trunk/SRC/ForOldVersion/updatenew.pro

    r55 r102  
    11;+ 
    2 ; 
    3 ; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr) 
    4 ;                       JUne 2005 
    5 ;- 
    6 ; 
     2; file_comments  
    73; common declaration 
    84; 
    95; check that key_forgetold and keep_compatibility are well defined... 
     6; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
     7;                       June 2005 
     8;- 
     9; 
    1010; 
    1111IF n_elements(key_forgetold) EQ 0 THEN keep_compatibility 

  • trunk/SRC/ForOldVersion/updateold.pro

    r55 r102  
    11;+ 
    2 ; 
    3 ; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr) 
     2; @file_comments 
     3; check that key_forgetold and keep_compatibility are well defined... 
     4; @history Sebastien Masson (smasson\@lodyc.jussieu.fr) 
    45;                       14/8/98 
    56;- 
    67; 
    7 ; 
    8 ; check that key_forgetold and keep_compatibility are well defined... 
    98; 
    109IF n_elements(key_forgetold) EQ 0 THEN keep_compatibility 

  • trunk/SRC/Interpolation/get_gridparams.pro

    r101 r102  
    3131; 
    3232; 2)  
    33 ; @param lon lat {in}{required}  1d or 2D arrays defining longitudes and latitudes.  
     33; @param in1 {in}{required}  1d or 2D arrays defining longitudes and latitudes.  
     34; @param in2 {in}{required}  1d or 2D arrays defining longitudes and latitudes.  
    3435;    Note that these arrays are also outputs and can therefore be modified.  
    3536 
    3637; @param in1 {out} the variable that will contain the longitudes 
    3738;  @param in2  {out} the variable that will contain the latitudes 
    38 ;  @param in3  {out} the number of points in the longitudinal direction 
    39 ;  @param in4  {out} the number of points in the latitudinal direction 
    40 ;  @param in5 {out} 1 or 2 to specify if lon and lat should be 1D (jpi or jpj) 
     39;  @param in3  {in} the number of points in the longitudinal direction 
     40;  @param in4  {in} the number of points in the latitudinal direction 
     41;  @param in5 {in} 1 or 2 to specify if lon and lat should be 1D (jpi or jpj) 
    4142;    arrays or 2D arrays (jpi,jpj). Note that of  n_dimensions = 1, then the 
    4243;    grid must be regular (each longitudes must be the same for all latitudes 
Note: See TracChangeset for help on using the changeset viewer.