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/matchdelim.html

    r157 r163  
    699699      </div> 
    700700 
    701       <div id="file_comments"></div> 
     701      <div id="file_comments"> 
     702 Match open/close delimiters in a string. 
     703</div> 
    702704 
    703705       
     
    712714         
    713715 
    714         <div class="routine_details" id="_Matchdelim"> 
    715  
    716           <h2><a class="top" href="#container">top</a>Matchdelim </h2> 
     716        <div class="routine_details" id="_matchdelim"> 
     717 
     718          <h2><a class="top" href="#container">top</a>matchdelim <span class="categories"> 
     719 Text, String 
     720</span></h2> 
    717721         
    718722          <p class="header"> 
    719             <span class="result">result = </span>Matchdelim(<span class="result"><a href="#_Matchdelim_param_InString">InString</a>, <a href="#_Matchdelim_param_OpenPos">OpenPos</a></span>, <a href="#_Matchdelim_keyword_OPEN_DELIM">OPEN_DELIM</a>=<span class="result">OPEN_DELIM</span>, <a href="#_Matchdelim_keyword_CLOSE_DELIM">CLOSE_DELIM</a>=<span class="result">CLOSE_DELIM</span>, <a href="#_Matchdelim_keyword_HELP">HELP</a>=<span class="result">HELP</span>)</p> 
     723            <span class="result">result = </span>matchdelim(<span class="result"><a href="#_matchdelim_param_InString">InString</a>[, <a href="#_matchdelim_param_OpenPos">OpenPos</a>]</span>, <a href="#_matchdelim_keyword_OPEN_DELIM">OPEN_DELIM</a>=<span class="result">OPEN_DELIM</span>, <a href="#_matchdelim_keyword_CLOSE_DELIM">CLOSE_DELIM</a>=<span class="result">CLOSE_DELIM</span>, <a href="#_matchdelim_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 
     729</div> 
     730 
     731           
     732            <h3>Parameters</h3> 
     733         
     734             
     735            <h4 id="_matchdelim_param_InString">InString&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> 
     745         
     746          <div class="comments">') 
     747</div> 
     748             
     749            <h4 id="_matchdelim_param_OpenPos">OpenPos&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     750              <span class="attr">in</span> 
     751               
     752              <span class="attr">optional</span> 
     753               
     754               
     755               
     756               
     757               
     758            </h4> 
    720759         
    721760          <div class="comments"> 
    722  NAME: 
    723        MATCHDELIM 
    724  PURPOSE: 
    725         Match open/close delimiters in a string. 
    726  CATEGORY: 
    727         text/strings 
    728  CALLING SEQUENCE: 
    729         position = matchdelim( strn, [openpos]) 
    730  INPUTS: 
    731         strn        -- a string containing an open                 in 
    732                        delimiter (e.g. '{') in which you  
    733                        want to find the matching closing   
    734                        delimiter (e.g. '}') 
    735  KEYWORD PARAMETERS: 
    736         OPEN_DELIM  -- A single character containing the opening   in 
    737                        delimiter (e.g. '(').  Default is '{' 
    738         CLOSE_DELIM -- A single character containing the closing   in 
    739                        delimiter (e.g. ')').  Default is '}' 
    740  OUTPUTS: 
    741         position -- returns the position in strn of the            out 
    742                     closing delimiter, -1 if no closing found. 
    743         openpos  -- Set to a named variable to receive the         out 
    744                     position of the first opening delimiter. 
    745                     Optional. 
    746  COMMON BLOCKS: 
    747  SIDE EFFECTS: 
    748  NOTES: 
    749         - Any pair of (nonidentical) characters can be used as 
    750           delimiters.  
    751  EXAMPLE: 
    752         matchdelim('{one{two}}three') returns 9, the character just 
    753         before 'three'.   
    754  MODIFICATION HISTORY: 
    755        $Id: matchdelim.pro 134 2006-07-07 10:19:08Z navarro $ 
    756        $Log: matchdelim.pro,v $ 
    757        Revision 1.3  1996/06/14 20:00:27  mcraig 
    758        Updated Copyright info. 
    759  
    760        Revision 1.2  1996/05/09 00:22:17  mcraig 
    761        Removed restriction that open delim must be first char.  Added argument 
    762        to allow for return of position of open delim. 
    763  
    764        Revision 1.1  1996/01/31 18:41:06  mcraig 
    765        Initial revision 
    766  
    767  RELEASE: 
    768        $Name: Rel_2_1_2 $ 
    769  
    770  COPYRIGHT: 
    771   Copyright (C) 1996 The Regents of the University of California, All 
    772   Rights Reserved.  Written by Matthew W. Craig. 
    773   See the file COPYRIGHT for restrictions on distrubting this code. 
    774   This code comes with absolutely NO warranty; see DISCLAIMER for details.</div> 
    775  
    776            
    777  
    778            
    779             <h3>Parameters</h3> 
    780          
    781              
    782             <h4 id="_Matchdelim_param_InString">InString&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    783                
    784                
    785                
    786                
    787                
    788                
    789                
    790                
    791             </h4> 
    792          
    793           <div class="comments"></div> 
    794              
    795             <h4 id="_Matchdelim_param_OpenPos">OpenPos&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    796                
    797                
    798                
    799                
    800                
    801                
    802                
    803                
    804             </h4> 
    805          
    806           <div class="comments"></div> 
     761 Set to a named variable to receive the 
     762 position of the first opening delimiter. 
     763</div> 
    807764             
    808765 
     
    813770            <h3>Keywords</h3> 
    814771             
    815             <h4 id="_Matchdelim_keyword_OPEN_DELIM">OPEN_DELIM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     772            <h4 id="_matchdelim_keyword_OPEN_DELIM">OPEN_DELIM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     773               
     774               
     775               
     776               
     777               
     778               
     779              <span class="attr">default:</span> <span class="value">'{'</span> 
     780               
     781            </h4> 
     782         
     783            <div class="comments"> 
     784 A single character containing the opening 
     785 delimiter (e.g. '('). 
     786</div> 
     787             
     788            <h4 id="_matchdelim_keyword_CLOSE_DELIM">CLOSE_DELIM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
     789               
     790               
     791               
     792               
     793               
     794               
     795              <span class="attr">default:</span> <span class="value">'</span> 
     796               
     797            </h4> 
     798         
     799            <div class="comments">'} 
     800 A single character containing the closing  
     801 delimiter (e.g. ')'). 
     802</div> 
     803             
     804            <h4 id="_matchdelim_keyword_HELP">HELP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    816805               
    817806               
     
    826815            <div class="comments"></div> 
    827816             
    828             <h4 id="_Matchdelim_keyword_CLOSE_DELIM">CLOSE_DELIM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    829                
    830                
    831                
    832                
    833                
    834                
    835                
    836                
    837             </h4> 
    838          
    839             <div class="comments"></div> 
    840              
    841             <h4 id="_Matchdelim_keyword_HELP">HELP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 
    842                
    843                
    844                
    845                
    846                
    847                
    848                
    849                
    850             </h4> 
    851          
    852             <div class="comments"></div> 
    853              
    854            
    855  
    856            
    857            
    858            
    859            
    860            
    861            
    862            
    863            
    864            
    865            
    866            
    867            
    868          
    869            
    870            
    871            
    872            
    873            
    874            
    875            
    876          
     817           
     818 
     819          <h3>Examples</h3><div class="preformat"> 
     820 matchdelim('{one{two}}three') returns 9, the character just before 'three'. 
     821</div> 
     822          <h3>Version history</h3> 
     823           
     824          <h4>Version</h4><div class="preformat"> 
     825 $Id: matchdelim.pro 134 2006-07-07 10:19:08Z navarro $</div> 
     826          <h4>History</h4><div class="preformat"> 
     827 $Log: matchdelim.pro,v $ 
     828 Revision 1.3  1996/06/14 20:00:27  mcraig 
     829 Updated Copyright info. 
     830 
     831 Revision 1.2  1996/05/09 00:22:17  mcraig 
     832 Removed restriction that open delim must be first char.  Added argument 
     833 to allow for return of position of open delim. 
     834 
     835 Revision 1.1  1996/01/31 18:41:06  mcraig 
     836 Initial revision; 
     837 
     838 Copyright (C) 1996 The Regents of the University of California, All 
     839 Rights Reserved.  Written by Matthew W. Craig. 
     840 See the file COPYRIGHT for restrictions on distrubting this code. 
     841 This code comes with absolutely NO warranty; see DISCLAIMER for details. 
     842</div> 
     843           
     844           
     845          <h3>Known issues</h3> 
     846           
     847           
     848           
     849          <h4>Restrictions</h4><div class="preformat"> 
     850 Any pair of (nonidentical) characters can be used as delimiters. 
     851</div> 
     852         
     853          <h3>Other attributes</h3> 
     854           
     855           
     856          <h4>Uses routines</h4><div class="preformat"> 
     857 
     858</div> 
     859           
     860           
     861           
     862         
     863          <h3>Statistics</h3> 
     864          <table class="statistics"> 
     865            <tr><td>McCabe cyclic</td><td>           8</td></tr> 
     866            <tr><td>McCabe essential</td><td>           1</td></tr> 
     867            <tr><td>McCabe modular design</td><td>           1</td></tr> 
     868          </table> 
    877869           
    878870         
Note: See TracChangeset for help on using the changeset viewer.