/usr/share/GNUstep/Documentation/Developer/Tools/Reference/AGSIndex.html is in gnustep-base-doc 1.25.1-2ubuntu3.
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 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 | <!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>
AGSIndex... a class to create references for a gsdoc
file
</title>
</head>
<body>
<font face="serif">
<a href="BaseTools.html">Up</a>
<br />
<h1><a name="title$AGSIndex">
AGSIndex... a class to create references for a gsdoc
file
</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">
Software documentation for the AGSIndex class
</a></h1>
<h2><a name="class$AGSIndex">AGSIndex</a> : NSObject</h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>AGSIndex.h</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
This class is used to build and manipulate a dictionary
of cross-reference information. <br /> The references are
held in a nested dictionary with strings at the leaves
(persisted to 'projectName'.igsdoc) - <br />
method : method-name - {class-name file-name} <br />
method : method-name - {protocol-name file-name}
<br /> ivariable : variable-name - {class-name
file-name} <br /> class : class-name - file-name
<br /> category : category-name - file-name <br />
protocol : protocol-name - file-name <br /> function
: function-name - file-name <br /> type : type-name -
file-name <br /> constant : constant-name -
file-name <br /> variable : variable-name -
file-name <br /> entry : entry-name - {file-name
ref} <br /> label : label-name - {file-name ref} <br />
contents : ref - text <br /> super : class-name -
superclass-name <br /> categories :
class-name - {category-name file-name} <br />
unitmethods : unit-name - method-name <br />
classvars : class-name - variables-name <br />
title : file-name - text <br /> source : file-name -
array-of-source-files <br />
</div>
<hr width="50%" align="left" />
<a href="#_AGSIndex_ivars">Instance Variables</a>
<br/><br/>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="AGSIndex.html#method$AGSIndex-addInformalProtocols$">-addInformalProtocols:</a></li>
<li><a rel="gsdoc" href="AGSIndex.html#method$AGSIndex-globalRef$type$">-globalRef:type:</a></li>
<li><a rel="gsdoc" href="AGSIndex.html#method$AGSIndex-makeRefs$">-makeRefs:</a></li>
<li><a rel="gsdoc" href="AGSIndex.html#method$AGSIndex-mergeRefs$override$">-mergeRefs:override:</a></li>
<li><a rel="gsdoc" href="AGSIndex.html#method$AGSIndex-methodsInUnit$">-methodsInUnit:</a></li>
<li><a rel="gsdoc" href="AGSIndex.html#method$AGSIndex-outputsForHeader$">-outputsForHeader:</a></li>
<li><a rel="gsdoc" href="AGSIndex.html#method$AGSIndex-refs">-refs</a></li>
<li><a rel="gsdoc" href="AGSIndex.html#method$AGSIndex-setDirectory$">-setDirectory:</a></li>
<li><a rel="gsdoc" href="AGSIndex.html#method$AGSIndex-setGlobalRef$type$">-setGlobalRef:type:</a></li>
<li><a rel="gsdoc" href="AGSIndex.html#method$AGSIndex-setOutputs$forHeader$">-setOutputs:forHeader:</a></li>
<li><a rel="gsdoc" href="AGSIndex.html#method$AGSIndex-setRelationship$from$to$">-setRelationship:from:to:</a></li>
<li><a rel="gsdoc" href="AGSIndex.html#method$AGSIndex-setSources$forHeader$">-setSources:forHeader:</a></li>
<li><a rel="gsdoc" href="AGSIndex.html#method$AGSIndex-setUnitRef$type$">-setUnitRef:type:</a></li>
<li><a rel="gsdoc" href="AGSIndex.html#method$AGSIndex-sourcesForHeader$">-sourcesForHeader:</a></li>
<li><a rel="gsdoc" href="AGSIndex.html#method$AGSIndex-unitRef$type$">-unitRef:type:</a></li>
<li><a rel="gsdoc" href="AGSIndex.html#method$AGSIndex-unitRef$type$unit$">-unitRef:type:unit:</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$AGSIndex-addInformalProtocols$">addInformalProtocols: </a></h3>
- (void) <b>addInformalProtocols:</b> (NSArray*)protocolNames;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Informal protocols are not explicitly marked in
source, but are inferred to be those categories of
NSObject that receive no implementation.
<a rel="gsdoc" href="AGSOutput.html#class$AGSOutput">AGSOutput</a>
finds and accumulates them; autogsdoc passes them
here, where each entry is found in the 'category'
section of our refs and copied over to the
protocol section.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$AGSIndex-globalRef$type$">globalRef: type: </a></h3>
- (NSString*) <b>globalRef:</b> (NSString*)ref<b> type:</b> (NSString*)type;<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$AGSIndex-makeRefs$">makeRefs: </a></h3>
- (void) <b>makeRefs:</b> (GSXMLNode*)node;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Given the root <var>node</var> of a gsdoc document,
we traverse the tree looking for interesting nodes, and
recording their names in a dictionary of
references.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$AGSIndex-mergeRefs$override$">mergeRefs: override: </a></h3>
- (void) <b>mergeRefs:</b> (NSDictionary*)more<b> override:</b> (BOOL)flag;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Merge a dictionary containing references into the
current index. The <var>flag</var> may be used to
specify that references being merged in should
override any pre-existing values.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$AGSIndex-methodsInUnit$">methodsInUnit: </a></h3>
- (NSArray*) <b>methodsInUnit:</b> (NSString*)aUnit;<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$AGSIndex-outputsForHeader$">outputsForHeader: </a></h3>
- (NSMutableArray*) <b>outputsForHeader:</b> (NSString*)h;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Return a list of output files for the header
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$AGSIndex-refs">refs </a></h3>
- (NSMutableDictionary*) <b>refs</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$AGSIndex-setDirectory$">setDirectory: </a></h3>
- (void) <b>setDirectory:</b> (NSString*)path;<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$AGSIndex-setGlobalRef$type$">setGlobalRef: type: </a></h3>
- (void) <b>setGlobalRef:</b> (NSString*)ref<b> type:</b> (NSString*)type;<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$AGSIndex-setOutputs$forHeader$">setOutputs: forHeader: </a></h3>
- (void) <b>setOutputs:</b> (NSArray*)a<b> forHeader:</b> (NSString*)h;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Set up an array listing the output files for
<var>a</var> particular header.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$AGSIndex-setRelationship$from$to$">setRelationship: from: to: </a></h3>
- (void) <b>setRelationship:</b> (NSString*)r<b> from:</b> (NSString*)from<b> to:</b> (NSString*)to;<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$AGSIndex-setSources$forHeader$">setSources: forHeader: </a></h3>
- (void) <b>setSources:</b> (NSArray*)a<b> forHeader:</b> (NSString*)h;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Set up an array listing the source files for
<var>a</var> particular header.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$AGSIndex-setUnitRef$type$">setUnitRef: type: </a></h3>
- (void) <b>setUnitRef:</b> (NSString*)ref<b> type:</b> (NSString*)type;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Set up a reference for something inside a unit (class,
category or protocol) We store 'method' and
'ivariable' by <var>ref</var> then unit
(class), but we store 'unitmethods' * and
'classvars' by unit then <var>ref</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$AGSIndex-sourcesForHeader$">sourcesForHeader: </a></h3>
- (NSMutableArray*) <b>sourcesForHeader:</b> (NSString*)h;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Return a list of source files for the header.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$AGSIndex-unitRef$type$">unitRef: type: </a></h3>
- (NSDictionary*) <b>unitRef:</b> (NSString*)ref<b> type:</b> (NSString*)type;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Return a dictionary containing info on all the units
containing the specified method or instance
variable.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$AGSIndex-unitRef$type$unit$">unitRef: type: unit: </a></h3>
- (NSString*) <b>unitRef:</b> (NSString*)ref<b> type:</b> (NSString*)type<b> unit:</b> (NSString**)u;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Return the name of the file containing the
<var>ref</var> and return the unit name in which it
was found. If not found, return <code>nil</code> for
both. <br /> If <var>ref</var> does not occur in the
index, this method returns <code>nil</code>. <br />
If the method was given no unit to look in, then it will
succeed and return a value if (and only if) the
required reference is defined only in one unit
(excluding protocols). In the case where it is
in two units (one of them a protocol) the class is taken
in preference to the protocol. <br /> If <var>ref</var>
exists in the unit specified, the method will
succeed and return the name of the file in which
the reference is located. <br /> If the unit that the
method has been asked to look in is a protocol which
is not found, the lookup must fail. <br /> Try all
superclasses in turn.
</div>
<hr width="25%" align="left" />
</div>
<a name="_AGSIndex_ivars"/> <br/><hr width="50%" align="left" />
<h2>Instance Variables for AGSIndex Class</h2>
<h3><a name="ivariable$AGSIndex*base">base</a></h3>
@protected NSString* <b>base</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$AGSIndex*category">category</a></h3>
@protected NSString* <b>category</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$AGSIndex*chap">chap</a></h3>
@protected unsigned int <b>chap</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$AGSIndex*classname">classname</a></h3>
@protected NSString* <b>classname</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$AGSIndex*refs">refs</a></h3>
@protected NSMutableDictionary* <b>refs</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$AGSIndex*sect">sect</a></h3>
@protected unsigned int <b>sect</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$AGSIndex*ssect">ssect</a></h3>
@protected unsigned int <b>ssect</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$AGSIndex*sssect">sssect</a></h3>
@protected unsigned int <b>sssect</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$AGSIndex*unit">unit</a></h3>
@protected NSString* <b>unit</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/>
<br />
<a href="BaseTools.html">Up</a>
</font>
</body>
</html>
|