/usr/share/GNUstep/Documentation/Developer/Tools/Reference/AGSOutput.html is in gnustep-base-doc 1.24.7-1build2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 | <!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's not really
reusable since it'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: unit: info: </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: from: to: maxSize: output: </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 </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: </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: kind: to: </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: to: </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 'args' 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: to: for: </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: to: </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: to: for: </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: to: </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: withIndent: to: </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: </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:
<NSCopying>-copyWithZone:
, a class:
NSString
, a protocol:
<NSCopying>
, and a category: NSRunLoop(GNUstepExtensions)
. </p>
<br />
<a href="BaseTools.html">Up</a>
</font>
</body>
</html>
|