Ignore:
Timestamp:
08/29/06 14:59:46 (18 years ago)
Author:
navarro
Message:

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/SRC/Documentation/idldoc_html_output/Textoidl/strcnt.html

    r157 r163  
    699699      </div> 
    700700 
    701       <div id="file_comments"></div> 
     701      <div id="file_comments"> 
     702 Count number of occurrences of a substring in a string. 
     703</div> 
    702704 
    703705       
     
    712714         
    713715 
    714         <div class="routine_details" id="_Strcnt"> 
    715  
    716           <h2><a class="top" href="#container">top</a>Strcnt </h2> 
     716        <div class="routine_details" id="_strcnt"> 
     717 
     718          <h2><a class="top" href="#container">top</a>strcnt <span class="categories"> 
     719 Text, String 
     720</span></h2> 
    717721         
    718722          <p class="header"> 
    719             <span class="result">result = </span>Strcnt(<span class="result"><a href="#_Strcnt_param_strn">strn</a>, <a href="#_Strcnt_param_substrn">substrn</a>, <a href="#_Strcnt_param_startpos">startpos</a></span>, <a href="#_Strcnt_keyword_HELP">HELP</a>=<span class="result">HELP</span>)</p> 
     723            <span class="result">result = </span>strcnt(<span class="result"><a href="#_strcnt_param_strn">strn</a>, <a href="#_strcnt_param_substrn">substrn</a>, <a href="#_strcnt_param_startpos">startpos</a></span>, <a href="#_strcnt_keyword_HELP">HELP</a>=<span class="result">HELP</span>)</p> 
     724         
     725          <div class="comments"></div> 
     726 
     727          <h3>Return value</h3><div class="preformat"> 
     728 Number of occurances of substring in string. 
     729</div> 
     730 
     731           
     732            <h3>Parameters</h3> 
     733         
     734             
     735            <h4 id="_strcnt_param_strn">strn&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     736              <span class="attr">in</span> 
     737               
     738               
     739              <span class="attr">required</span> 
     740               
     741              <span class="attr">type:</span> <span class="value">string</span> 
     742               
     743               
     744            </h4> 
    720745         
    721746          <div class="comments"> 
    722  NAME: 
    723        STRCNT 
    724  PURPOSE: 
    725        Count number of occurrences of a substring in a string. 
    726  CATEGORY: 
    727        text/strings 
    728  CALLING SEQUENCE: 
    729        num = strcnt(strn, substring, [pos]) 
    730  INPUTS: 
    731        string    -- The string in which to count occurences.     in 
    732        substring -- The substring to count occurrences of.       in 
    733        pos       -- the position at which to begin the search.   [in] 
    734                     If not supplied, start at beginning of 
    735                     string. 
    736  KEYWORD PARAMETERS: 
    737        /HELP     -- Print useful message and return. 
    738  OUTPUTS: 
    739        num       -- Number of occurances of substring in string. out 
    740  COMMON BLOCKS: 
    741  SIDE EFFECTS: 
    742  NOTES: 
    743        Overlapping occurances are not counted separately.  For 
    744        example, counting occurances of 'bb' in 'blah bbb' returns one 
    745        occurance.  
    746  EXAMPLE: 
    747  MODIFICATION HISTORY: 
    748        $Id: strcnt.pro 134 2006-07-07 10:19:08Z navarro $ 
     747 The string in which to count occurences. 
     748</div> 
     749             
     750            <h4 id="_strcnt_param_substrn">substrn&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     751              <span class="attr">in</span> 
     752               
     753               
     754              <span class="attr">required</span> 
     755               
     756              <span class="attr">type:</span> <span class="value">string</span> 
     757               
     758               
     759            </h4> 
     760         
     761          <div class="comments"> 
     762 The substring to count occurrences of. 
     763</div> 
     764             
     765            <h4 id="_strcnt_param_startpos">startpos&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     766              <span class="attr">in</span> 
     767               
     768               
     769              <span class="attr">required</span> 
     770               
     771               
     772               
     773               
     774            </h4> 
     775         
     776          <div class="comments"> 
     777 The position at which to begin the search. 
     778 If not supplied, start at beginning of string. 
     779</div> 
     780             
     781 
     782           
     783 
     784           
     785 
     786            <h3>Keywords</h3> 
     787             
     788            <h4 id="_strcnt_keyword_HELP">HELP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     789               
     790               
     791               
     792               
     793               
     794               
     795               
     796               
     797            </h4> 
     798         
     799            <div class="comments"> 
     800 Print useful message and return. 
     801</div> 
     802             
     803           
     804 
     805           
     806          <h3>Version history</h3> 
     807           
     808          <h4>Version</h4><div class="preformat"> 
     809 $Id: strcnt.pro 134 2006-07-07 10:19:08Z navarro $</div> 
     810          <h4>History</h4><div class="preformat"> 
    749811       $Log: strcnt.pro,v $ 
    750812       Revision 1.3  1996/06/14 20:00:27  mcraig 
     
    758820       Initial revision 
    759821 
    760  RELEASE: 
    761        $Name: Rel_2_1_2 $ 
    762  
    763  COPYRIGHT: 
    764822  Copyright (C) 1996 The Regents of the University of California, All 
    765823  Rights Reserved.  Written by Matthew W. Craig. 
    766824  See the file COPYRIGHT for restrictions on distrubting this code. 
    767   This code comes with absolutely NO warranty; see DISCLAIMER for details.</div> 
    768  
    769            
    770  
    771            
    772             <h3>Parameters</h3> 
    773          
    774              
    775             <h4 id="_Strcnt_param_strn">strn&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    776                
    777                
    778                
    779                
    780                
    781                
    782                
    783                
    784             </h4> 
    785          
    786           <div class="comments"></div> 
    787              
    788             <h4 id="_Strcnt_param_substrn">substrn&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    789                
    790                
    791                
    792                
    793                
    794                
    795                
    796                
    797             </h4> 
    798          
    799           <div class="comments"></div> 
    800              
    801             <h4 id="_Strcnt_param_startpos">startpos&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    802                
    803                
    804                
    805                
    806                
    807                
    808                
    809                
    810             </h4> 
    811          
    812           <div class="comments"></div> 
    813              
    814  
    815            
    816  
    817            
    818  
    819             <h3>Keywords</h3> 
    820              
    821             <h4 id="_Strcnt_keyword_HELP">HELP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    822                
    823                
    824                
    825                
    826                
    827                
    828                
    829                
    830             </h4> 
    831          
    832             <div class="comments"></div> 
    833              
    834            
    835  
    836            
    837            
    838            
    839            
    840            
    841            
    842            
    843            
    844            
    845            
    846            
    847            
    848          
    849            
    850            
    851            
    852            
    853            
    854            
    855            
    856          
     825  This code comes with absolutely NO warranty; see DISCLAIMER for details. 
     826</div> 
     827           
     828           
     829          <h3>Known issues</h3> 
     830           
     831           
     832           
     833          <h4>Restrictions</h4><div class="preformat"> 
     834 Overlapping occurances are not counted separately.  For 
     835 example, counting occurances of 'bb' in 'blah bbb' returns one 
     836 occurance.  
     837</div> 
     838         
     839           
     840           
     841           
     842           
     843           
     844           
     845           
     846         
     847          <h3>Statistics</h3> 
     848          <table class="statistics"> 
     849            <tr><td>McCabe cyclic</td><td>           7</td></tr> 
     850            <tr><td>McCabe essential</td><td>           1</td></tr> 
     851            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     852          </table> 
    857853           
    858854         
Note: See TracChangeset for help on using the changeset viewer.