/usr/share/GNUstep/Documentation/Developer/Tools/Reference/AGSHtml.gsdoc 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 | <?xml version="1.0"?>
<!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 1.0.4//EN" "http://www.gnustep.org/gsdoc-1_0_4.dtd">
<gsdoc base="AGSHtml" up="BaseTools">
<head>
<title>
AGSHtml... a class to output html for a gsdoc file
</title>
<author name="Richard Frith-Macdonald">
<email address="richard@brainstorm.co.uk">
richard@brainstorm.co.uk
</email>
</author>
<copy>2001 Free Software Foundation, Inc.</copy>
</head>
<body>
<front><contents /></front>
<chapter>
<heading>
Software documentation for the AGSHtml class
</heading>
<class name="AGSHtml" super="NSObject" ovadd="1.0.0">
<declared>AGSHtml.h</declared>
<desc>
<em>Description forthcoming.</em>
</desc>
<ivariable type="NSString*" name="base" validity="protected" ovadd="1.0.0">
<desc>
<em>Description forthcoming.</em>
</desc>
</ivariable>
<ivariable type="NSString*" name="category" validity="protected" ovadd="1.0.0">
<desc>
<em>Description forthcoming.</em>
</desc>
</ivariable>
<ivariable type="unsigned int" name="chap" validity="protected" ovadd="1.0.0">
<desc>
<em>Description forthcoming.</em>
</desc>
</ivariable>
<ivariable type="NSString*" name="classname" validity="protected" ovadd="1.0.0">
<desc>
<em>Description forthcoming.</em>
</desc>
</ivariable>
<ivariable type="AGSIndex*" name="globalRefs" validity="protected" ovadd="1.0.0">
<desc>
<em>Description forthcoming.</em>
</desc>
</ivariable>
<ivariable type="NSString*" name="heading" validity="protected" ovadd="1.0.0">
<desc>
<em>Description forthcoming.</em>
</desc>
</ivariable>
<ivariable type="NSMutableString*" name="indent" validity="protected" ovadd="1.0.0">
<desc>
<em>Description forthcoming.</em>
</desc>
</ivariable>
<ivariable type="BOOL" name="isContentsDoc" validity="protected" ovadd="1.0.0">
<desc>
<em>Description forthcoming.</em>
</desc>
</ivariable>
<ivariable type="BOOL" name="ivarsAtEnd" validity="protected" ovadd="1.0.0">
<desc>
<em>Description forthcoming.</em>
</desc>
</ivariable>
<ivariable type="AGSIndex*" name="localRefs" validity="protected" ovadd="1.0.0">
<desc>
<em>Description forthcoming.</em>
</desc>
</ivariable>
<ivariable type="NSString*" name="nextFile" validity="protected" ovadd="1.0.0">
<desc>
<em>Description forthcoming.</em>
</desc>
</ivariable>
<ivariable type="NSString*" name="prevFile" validity="protected" ovadd="1.0.0">
<desc>
<em>Description forthcoming.</em>
</desc>
</ivariable>
<ivariable type="NSString*" name="project" validity="protected" ovadd="1.0.0">
<desc>
<em>Description forthcoming.</em>
</desc>
</ivariable>
<ivariable type="AGSIndex*" name="projectRefs" validity="protected" ovadd="1.0.0">
<desc>
<em>Description forthcoming.</em>
</desc>
</ivariable>
<ivariable type="unsigned int" name="sect" validity="protected" ovadd="1.0.0">
<desc>
<em>Description forthcoming.</em>
</desc>
</ivariable>
<ivariable type="unsigned int" name="ssect" validity="protected" ovadd="1.0.0">
<desc>
<em>Description forthcoming.</em>
</desc>
</ivariable>
<ivariable type="unsigned int" name="sssect" validity="protected" ovadd="1.0.0">
<desc>
<em>Description forthcoming.</em>
</desc>
</ivariable>
<ivariable type="NSString*" name="unit" validity="protected" ovadd="1.0.0">
<desc>
<em>Description forthcoming.</em>
</desc>
</ivariable>
<ivariable type="NSString*" name="upFile" validity="protected" ovadd="1.0.0">
<desc>
<em>Description forthcoming.</em>
</desc>
</ivariable>
<method type="void" ovadd="1.0.0">
<sel>decIndent</sel>
<desc>
<em>Description forthcoming.</em>
</desc>
</method>
<method type="void" ovadd="1.0.0">
<sel>incIndent</sel>
<desc>
<em>Description forthcoming.</em>
</desc>
</method>
<method type="NSString*" ovadd="1.0.0">
<sel>makeAnchor:</sel>
<arg type="NSString*">r</arg>
<sel>ofType:</sel>
<arg type="NSString*">t</arg>
<sel>name:</sel>
<arg type="NSString*">n</arg>
<desc>
Calls
<ref type="method" id="-makeLink:ofType:isRef:">
-makeLink:ofType:isRef:
</ref>
or
<ref type="method" id="-makeLink:ofType:inUnit:isRef:">
-makeLink:ofType:inUnit:isRef:
</ref>
to create the first part of an anchor, and fills in the
text content of the anchor with <var>n</var> (the
specified name). Returns an entire anchor string
as a result. <br /> This method is used to create all
the anchors in the html output.
</desc>
</method>
<method type="NSString*" ovadd="1.0.0">
<sel>makeLink:</sel>
<arg type="NSString*">r</arg>
<sel>ofType:</sel>
<arg type="NSString*">t</arg>
<sel>inUnit:</sel>
<arg type="NSString*">u</arg>
<sel>isRef:</sel>
<arg type="BOOL">f</arg>
<desc>
Make a link for the element <var>r</var>, with the
specified type <var>t</var>, in a particular unit
<var>u</var>. Only the start of the html element is
returned (<a...>). <br /> If the boolean
<var>f</var> is <code>YES</code>, then the link is a
reference to somewhere, otherwise the link is an
anchor for some element being output. <br /> If
there is an error, the method returns
<code>nil</code>.
</desc>
</method>
<method type="NSString*" ovadd="1.0.0">
<sel>makeLink:</sel>
<arg type="NSString*">r</arg>
<sel>ofType:</sel>
<arg type="NSString*">t</arg>
<sel>isRef:</sel>
<arg type="BOOL">f</arg>
<desc>
Make a link for the element <var>r</var> with the
specified type. Only the start of the html
element is returned (<a...>). If the boolean
<var>f</var> is <code>YES</code>, then the link is a
reference to somewhere, and the method will
return <code>nil</code> if the destination is not
found in the index. If <var>f</var> is
<code>NO</code>, then the link is an anchor for some
element being output, and the method is guaranteed
to succeed and return the link.
</desc>
</method>
<method type="GSXMLNode*" ovadd="1.0.0">
<sel>outputBlock:</sel>
<arg type="GSXMLNode*">node</arg>
<sel>to:</sel>
<arg type="NSMutableString*">buf</arg>
<sel>inPara:</sel>
<arg type="BOOL">flag</arg>
<desc>
Outputs zero or more nodes at the same level as
<strong>long</strong> as the nodes are valid
%block elements. Returns <code>nil</code> or the
first <var>node</var> not output. The value of
<var>flag</var> is used to control paragraph nesting
... if <code>YES</code> we close a paragraph before
opening a new one, and open again once the new
paragraph closes.
</desc>
</method>
<method type="NSString*" ovadd="1.0.0">
<sel>outputDocument:</sel>
<arg type="GSXMLNode*">node</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
</method>
<method type="void" ovadd="1.0.0">
<sel>outputIndex:</sel>
<arg type="NSString*">type</arg>
<sel>scope:</sel>
<arg type="NSString*">scope</arg>
<sel>title:</sel>
<arg type="NSString*">title</arg>
<sel>style:</sel>
<arg type="NSString*">style</arg>
<sel>target:</sel>
<arg type="NSString*">target</arg>
<sel>to:</sel>
<arg type="NSMutableString*">buf</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
</method>
<method type="GSXMLNode*" ovadd="1.0.0">
<sel>outputList:</sel>
<arg type="GSXMLNode*">node</arg>
<sel>to:</sel>
<arg type="NSMutableString*">buf</arg>
<desc>
Outputs a <var>node</var> as <strong>long</strong>
as it is a valid %list element. Returns next
<var>node</var> at this level.
</desc>
</method>
<method type="void" ovadd="1.0.0">
<sel>outputNode:</sel>
<arg type="GSXMLNode*">node</arg>
<sel>to:</sel>
<arg type="NSMutableString*">buf</arg>
<desc>
Css : TODO print.css <br /> Robots <br /> As a special
case, if we have a reference to a function, and we
can't find it, we check to see if there is actually a
macro of that name and refer to that instead.
</desc>
</method>
<method type="void" ovadd="1.0.0">
<sel>outputNodeList:</sel>
<arg type="GSXMLNode*">node</arg>
<sel>to:</sel>
<arg type="NSMutableString*">buf</arg>
<desc>
Output all the nodes from this one onwards... try to
output as text first, if not possible, call the main
method to output each <var>node</var>.
</desc>
</method>
<method type="GSXMLNode*" ovadd="1.0.0">
<sel>outputText:</sel>
<arg type="GSXMLNode*">node</arg>
<sel>to:</sel>
<arg type="NSMutableString*">buf</arg>
<desc>
Outputs zero or more nodes at the same level as
<strong>long</strong> as the nodes are valid %text
elements. Returns <code>nil</code> or the first
<var>node</var> not output.
</desc>
</method>
<method type="void" ovadd="1.0.0">
<sel>outputUnit:</sel>
<arg type="GSXMLNode*">node</arg>
<sel>to:</sel>
<arg type="NSMutableString*">buf</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
</method>
<method type="void" ovadd="1.0.0">
<sel>outputVersion:</sel>
<arg type="NSDictionary*">prop</arg>
<sel>to:</sel>
<arg type="NSMutableString*">buf</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
</method>
<method type="NSString*" ovadd="1.0.0">
<sel>protocolRef:</sel>
<arg type="NSString*">t</arg>
<desc>
Try to make a link to the documentation for the
supplied protocol.
</desc>
</method>
<method type="void" ovadd="1.0.0">
<sel>setGlobalRefs:</sel>
<arg type="AGSIndex*">r</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
</method>
<method type="void" ovadd="1.0.0">
<sel>setInstanceVariablesAtEnd:</sel>
<arg type="BOOL">val</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
</method>
<method type="void" ovadd="1.0.0">
<sel>setLocalRefs:</sel>
<arg type="AGSIndex*">r</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
</method>
<method type="void" ovadd="1.0.0">
<sel>setProjectRefs:</sel>
<arg type="AGSIndex*">r</arg>
<desc>
<em>Description forthcoming.</em>
</desc>
</method>
<method type="NSString*" ovadd="1.0.0">
<sel>typeRef:</sel>
<arg type="NSString*">t</arg>
<desc>
Assuming that the supplied string contains type
information (as used in a method declaration or
type cast), we make an attempt at extracting the basic
type, and seeing if we can find a documented
declaration for it. If we can, we return a
modified version of the string containing a link
to the appropriate documentation. Otherwise, we just
return the plain type string. In all cases, we strip
leading and trailing white space.
</desc>
</method>
</class>
</chapter>
</body>
</gsdoc>
|