/usr/share/doc/cxref-doc/examples/comment.c.html is in cxref-doc 1.6d-6.
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 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- This HTML file generated by cxref (version 1.6d). -->
<!-- cxref program (c) Andrew M. Bishop 1995-2011. -->
<!--
Cxref: ./cxref -warn-xref -xref -O../doc/example -Ncxref -latex -html-src -rtf -sgml comment.c
CPP : /build/buildd/cxref-1.6d/cpp/cxref-cpp -cxref-cpp-defines /build/buildd/cxref-1.6d/cpp/cxref-cpp.defines -lang-c -C -dD -dI
-->
<HTML>
<HEAD>
<TITLE>Cross reference for comment.c of cxref.</TITLE>
<LINK rel="stylesheet" href="cxref.css" type="text/css">
</HEAD>
<BODY>
<h1><a name="file" href="comment.c.src.html">File comment.c</a></h1>
<b>RCS Header: /home/amb/CVS/cxref/src/comment.c,v 1.22 2003-01-17 19:07:56 amb Exp </b>
<p>
<span class="cxref-file-comment">
C Cross Referencing & Documentation tool. Version 1.5e.
<br>
Collects the comments from the parser.</span>
<p>
<hr>
<h2>Included Files</h2>
<ul class="cxref-include">
<li class="cxref-include-system"><tt><span class="cxref-include-system">#include <stdlib.h></span></tt>
</ul>
<ul class="cxref-include">
<li class="cxref-include-system"><tt><span class="cxref-include-system">#include <stdio.h></span></tt>
</ul>
<ul class="cxref-include">
<li class="cxref-include-system"><tt><span class="cxref-include-system">#include <string.h></span></tt>
</ul>
<ul class="cxref-include">
<li class="cxref-include-local"><tt><span class="cxref-include-local"><a href="memory.h.html#file">#include "memory.h"</a></span></tt>
</ul>
<ul class="cxref-include">
<li class="cxref-include-local"><tt><span class="cxref-include-local"><a href="datatype.h.html#file">#include "datatype.h"</a></span></tt>
</ul>
<ul class="cxref-include">
<li class="cxref-include-local"><tt><span class="cxref-include-local"><a href="cxref.h.html#file">#include "cxref.h"</a></span></tt>
<ul class="cxref-include">
<li class="cxref-include-local"><tt><span class="cxref-include-local"><a href="datatype.h.html#file">#include "datatype.h"</a></span></tt>
</ul>
</ul>
<hr>
<h2>Preprocessor definitions</h2>
<span class="cxref-define-comment"> Turn on the debugging in this file. </span>
<p>
<tt><span class="cxref-define"><a href="comment.c.src.html#line17">#define DEBUG</a> 0</span></tt><br>
<hr>
<h2>External Variables</h2>
<b><a name="var-option_verbatim_comments">option_verbatim_comments</a></b><br>
<span class="cxref-variable-comment"> The option to insert the comments verbatim into the output. </span>
<p>
<tt><span class="cxref-variable">extern int option_verbatim_comments</span></tt><br>
<table>
<tr>
<td>Defined in:
<td><span class="cxref-reference-local"><a href="cxref.c.html#var-option_verbatim_comments">cxref.c</a></span>
</tr>
</table>
<p>
<b><a name="var-CurFile">CurFile</a></b><br>
<span class="cxref-variable-comment"> The file that is currently being processed. </span>
<p>
<tt><span class="cxref-variable">extern File CurFile</span></tt><br>
<table>
<tr>
<td>Defined in:
<td><span class="cxref-reference-local"><a href="cxref.c.html#var-CurFile">cxref.c</a></span>
</tr>
</table>
<p>
<b><a name="var-parse_file">parse_file</a></b><br>
<span class="cxref-variable-comment"> The name of the current file. </span>
<p>
<tt><span class="cxref-variable">extern char* parse_file</span></tt><br>
<table>
<tr>
<td>Defined in:
<td><span class="cxref-reference-local"><a href="parse-lex.c.html#var-parse_file">parse-lex.c</a></span>
</tr>
</table>
<hr>
<h2>Local Variables</h2>
<b><a name="var-current_comment">current_comment</a></b><br>
<span class="cxref-variable-comment"> The current (latest) comment. </span>
<p>
<tt><span class="cxref-variable"><a href="comment.c.src.html#line39">static char* current_comment</a></span></tt><br>
<table>
<tr>
<td>Used in:
<td><a href="#func-DeleteComment">DeleteComment()</a>
<td>
</tr>
<tr>
<td>
<td><a href="#func-GetCurrentComment">GetCurrentComment()</a>
<td>
</tr>
<tr>
<td>
<td><a href="#func-SeenComment">SeenComment()</a>
<td>
</tr>
<tr>
<td>
<td><a href="#func-SetCurrentComment">SetCurrentComment()</a>
<td>
</tr>
</table>
<p>
<b><a name="var-malloc_comment">malloc_comment</a></b><br>
<span class="cxref-variable-comment"> The malloced string for the current comment. </span>
<p>
<tt><span class="cxref-variable"><a href="comment.c.src.html#line42">static char* malloc_comment</a></span></tt><br>
<table>
<tr>
<td>Used in:
<td><a href="#func-DeleteComment">DeleteComment()</a>
<td>
</tr>
<tr>
<td>
<td><a href="#func-SeenComment">SeenComment()</a>
<td>
</tr>
<tr>
<td>
<td><a href="#func-SetCurrentComment">SetCurrentComment()</a>
<td>
</tr>
</table>
<p>
<b><a name="var-comment_ended">comment_ended</a></b><br>
<span class="cxref-variable-comment"> The status of the current comment. </span>
<p>
<tt><span class="cxref-variable"><a href="comment.c.src.html#line45">static int comment_ended</a></span></tt><br>
<table>
<tr>
<td>Used in:
<td><a href="#func-DeleteComment">DeleteComment()</a>
<td>
</tr>
<tr>
<td>
<td><a href="#func-SeenComment">SeenComment()</a>
<td>
</tr>
</table>
<hr>
<h2><a name="func-DeleteComment">Global Function DeleteComment()</a></h2>
<span class="cxref-function-comment"> Delete the malloced string for the comment</span>
<p>
<tt><span class="cxref-function"><a href="comment.c.src.html#line356">void DeleteComment ( void )</a></span></tt><br>
<table>
<tr>
<td>Prototyped in:
<td colspan=2><span class="cxref-reference-local"><a href="cxref.h.html#file">cxref.h</a></span>
</tr>
<tr>
<td>Calls:
<td><span class="cxref-reference-local"><a href="memory.c.html#func-SafeFree">SafeFree()</a></span>
<td><span class="cxref-reference-local"><a href="memory.c.html#func-SafeFree">memory.c</a></span>
</tr>
<tr>
<td>Called by:
<td><span class="cxref-reference-local"><a href="cxref.c.html#func-main">main()</a></span>
<td><span class="cxref-reference-local"><a href="cxref.c.html#func-main">cxref.c</a></span>
</tr>
<tr>
<td>References Variables:
<td><span class="cxref-reference-local"><a href="comment.c.html#var-comment_ended">comment_ended</a></span>
<td><span class="cxref-reference-local"><a href="comment.c.html#var-comment_ended">comment.c</a></span>
</tr>
<tr>
<td>
<td><span class="cxref-reference-local"><a href="comment.c.html#var-current_comment">current_comment</a></span>
<td><span class="cxref-reference-local"><a href="comment.c.html#var-current_comment">comment.c</a></span>
</tr>
<tr>
<td>
<td><span class="cxref-reference-local"><a href="comment.c.html#var-malloc_comment">malloc_comment</a></span>
<td><span class="cxref-reference-local"><a href="comment.c.html#var-malloc_comment">comment.c</a></span>
</tr>
</table>
<hr>
<h2><a name="func-GetCurrentComment">Global Function GetCurrentComment()</a></h2>
<span class="cxref-function-comment"> Provide the current (latest) comment.</span>
<p>
<tt><span class="cxref-function"><a href="comment.c.src.html#line133">char* GetCurrentComment ( void )</a></span></tt><br>
<dl compact>
<dt><tt><span class="cxref-function">char* GetCurrentComment</span></tt>
<dd><span class="cxref-function-comment">Returns the current (latest) comment.</span>
</dl>
<table>
<tr>
<td>Prototyped in:
<td colspan=2><span class="cxref-reference-local"><a href="cxref.h.html#file">cxref.h</a></span>
</tr>
<tr>
<td>Called by:
<td><span class="cxref-reference-local"><a href="preproc.c.html#func-SeenDefine">SeenDefine()</a></span>
<td><span class="cxref-reference-local"><a href="preproc.c.html#func-SeenDefine">preproc.c</a></span>
</tr>
<tr>
<td>
<td><span class="cxref-reference-local"><a href="preproc.c.html#func-SeenDefineComment">SeenDefineComment()</a></span>
<td><span class="cxref-reference-local"><a href="preproc.c.html#func-SeenDefineComment">preproc.c</a></span>
</tr>
<tr>
<td>
<td><span class="cxref-reference-local"><a href="preproc.c.html#func-SeenDefineFuncArgComment">SeenDefineFuncArgComment()</a></span>
<td><span class="cxref-reference-local"><a href="preproc.c.html#func-SeenDefineFuncArgComment">preproc.c</a></span>
</tr>
<tr>
<td>
<td><span class="cxref-reference-local"><a href="func.c.html#func-SeenFunctionArg">SeenFunctionArg()</a></span>
<td><span class="cxref-reference-local"><a href="func.c.html#func-SeenFunctionArg">func.c</a></span>
</tr>
<tr>
<td>
<td><span class="cxref-reference-local"><a href="func.c.html#func-SeenFunctionDeclaration">SeenFunctionDeclaration()</a></span>
<td><span class="cxref-reference-local"><a href="func.c.html#func-SeenFunctionDeclaration">func.c</a></span>
</tr>
<tr>
<td>
<td><span class="cxref-reference-local"><a href="func.c.html#func-SeenFunctionDefinition">SeenFunctionDefinition()</a></span>
<td><span class="cxref-reference-local"><a href="func.c.html#func-SeenFunctionDefinition">func.c</a></span>
</tr>
<tr>
<td>
<td><span class="cxref-reference-local"><a href="preproc.c.html#func-SeenInclude">SeenInclude()</a></span>
<td><span class="cxref-reference-local"><a href="preproc.c.html#func-SeenInclude">preproc.c</a></span>
</tr>
<tr>
<td>
<td><span class="cxref-reference-local"><a href="preproc.c.html#func-SeenIncludeComment">SeenIncludeComment()</a></span>
<td><span class="cxref-reference-local"><a href="preproc.c.html#func-SeenIncludeComment">preproc.c</a></span>
</tr>
<tr>
<td>
<td><span class="cxref-reference-local"><a href="type.c.html#func-SeenStructUnionComp">SeenStructUnionComp()</a></span>
<td><span class="cxref-reference-local"><a href="type.c.html#func-SeenStructUnionComp">type.c</a></span>
</tr>
<tr>
<td>
<td><span class="cxref-reference-local"><a href="type.c.html#func-SeenStructUnionStart">SeenStructUnionStart()</a></span>
<td><span class="cxref-reference-local"><a href="type.c.html#func-SeenStructUnionStart">type.c</a></span>
</tr>
<tr>
<td>
<td><span class="cxref-reference-local"><a href="type.c.html#func-SeenTypedef">SeenTypedef()</a></span>
<td><span class="cxref-reference-local"><a href="type.c.html#func-SeenTypedef">type.c</a></span>
</tr>
<tr>
<td>
<td><span class="cxref-reference-local"><a href="var.c.html#func-SeenVariableDefinition">SeenVariableDefinition()</a></span>
<td><span class="cxref-reference-local"><a href="var.c.html#func-SeenVariableDefinition">var.c</a></span>
</tr>
<tr>
<td>
<td><span class="cxref-reference-local"><a href="parse-lex.c.html#func-yylex">yylex()</a></span>
<td><span class="cxref-reference-local"><a href="parse-lex.c.html#func-yylex">parse-lex.c</a></span>
</tr>
<tr>
<td>
<td><span class="cxref-reference-local"><a href="parse-yacc.c.html#func-yyparse">yyparse()</a></span>
<td><span class="cxref-reference-local"><a href="parse-yacc.c.html#func-yyparse">parse-yacc.c</a></span>
</tr>
<tr>
<td>References Variables:
<td><span class="cxref-reference-local"><a href="comment.c.html#var-current_comment">current_comment</a></span>
<td><span class="cxref-reference-local"><a href="comment.c.html#var-current_comment">comment.c</a></span>
</tr>
</table>
<hr>
<h2><a name="func-SeenComment">Global Function SeenComment()</a></h2>
<span class="cxref-function-comment"> Function that is called when a comment or part of one is seen. The comment is built up until an end of comment is signaled.</span>
<p>
<tt><span class="cxref-function"><a href="comment.c.src.html#line60">void SeenComment ( char* c, int flag )</a></span></tt><br>
<dl compact>
<dt><tt><span class="cxref-function">char* c</span></tt>
<dd><span class="cxref-function-comment">The comment text.</span>
<dt><tt><span class="cxref-function">int flag</span></tt>
<dd><span class="cxref-function-comment">A flag to indicate the type of comment that it is.
if flag==0 then it is a comment of some sort.
If flag==1 then it is the end of a file (/ * * comment * * /) comment
if flag==2 then it is the end of the other special comment (/ * + comment + * /).
if flag==3 then it is the end of a normal comment (/ * comment * /).</span>
</dl>
<table>
<tr>
<td>Prototyped in:
<td colspan=2><span class="cxref-reference-local"><a href="cxref.h.html#file">cxref.h</a></span>
</tr>
<tr>
<td>Calls:
<td><span class="cxref-reference-local"><a href="memory.c.html#func-SafeMalloc">SafeMalloc()</a></span>
<td><span class="cxref-reference-local"><a href="memory.c.html#func-SafeMalloc">memory.c</a></span>
</tr>
<tr>
<td>
<td><span class="cxref-reference-local"><a href="memory.c.html#func-SafeRealloc">SafeRealloc()</a></span>
<td><span class="cxref-reference-local"><a href="memory.c.html#func-SafeRealloc">memory.c</a></span>
</tr>
<tr>
<td>
<td><span class="cxref-reference-local"><a href="file.c.html#func-SeenFileComment">SeenFileComment()</a></span>
<td><span class="cxref-reference-local"><a href="file.c.html#func-SeenFileComment">file.c</a></span>
</tr>
<tr>
<td>
<td><span class="cxref-reference-local"><a href="func.c.html#func-SeenFuncIntComment">SeenFuncIntComment()</a></span>
<td><span class="cxref-reference-local"><a href="func.c.html#func-SeenFuncIntComment">func.c</a></span>
</tr>
<tr>
<td>
<td><span class="cxref-reference-local"><a href="comment.c.html#func-TidyCommentString">TidyCommentString()</a></span>
<td><span class="cxref-reference-local"><a href="comment.c.html#func-TidyCommentString">comment.c</a></span>
</tr>
<tr>
<td>
<td colspan=2><span class="cxref-reference-system">strcat(), strcmp(), strcpy(), strlen()</span>
</tr>
<tr>
<td>Called by:
<td><span class="cxref-reference-local"><a href="parse-lex.c.html#func-yylex">yylex()</a></span>
<td><span class="cxref-reference-local"><a href="parse-lex.c.html#func-yylex">parse-lex.c</a></span>
</tr>
<tr>
<td>References Variables:
<td><span class="cxref-reference-local"><a href="cxref.c.html#var-CurFile">CurFile</a></span>
<td><span class="cxref-reference-local"><a href="cxref.c.html#var-CurFile">cxref.c</a></span>
</tr>
<tr>
<td>
<td><span class="cxref-reference-local"><a href="comment.c.html#var-comment_ended">comment_ended</a></span>
<td><span class="cxref-reference-local"><a href="comment.c.html#var-comment_ended">comment.c</a></span>
</tr>
<tr>
<td>
<td><span class="cxref-reference-local"><a href="comment.c.html#var-current_comment">current_comment</a></span>
<td><span class="cxref-reference-local"><a href="comment.c.html#var-current_comment">comment.c</a></span>
</tr>
<tr>
<td>
<td><span class="cxref-reference-local"><a href="comment.c.html#var-malloc_comment">malloc_comment</a></span>
<td><span class="cxref-reference-local"><a href="comment.c.html#var-malloc_comment">comment.c</a></span>
</tr>
<tr>
<td>
<td><span class="cxref-reference-local"><a href="cxref.c.html#var-option_verbatim_comments">option_verbatim_comments</a></span>
<td><span class="cxref-reference-local"><a href="cxref.c.html#var-option_verbatim_comments">cxref.c</a></span>
</tr>
<tr>
<td>
<td><span class="cxref-reference-local"><a href="parse-lex.c.html#var-parse_file">parse_file</a></span>
<td><span class="cxref-reference-local"><a href="parse-lex.c.html#var-parse_file">parse-lex.c</a></span>
</tr>
</table>
<hr>
<h2><a name="func-SetCurrentComment">Global Function SetCurrentComment()</a></h2>
<span class="cxref-function-comment"> Set the current (latest) comment.</span>
<p>
<tt><span class="cxref-function"><a href="comment.c.src.html#line153">void SetCurrentComment ( char* comment )</a></span></tt><br>
<dl compact>
<dt><tt><span class="cxref-function">char* comment</span></tt>
<dd><span class="cxref-function-comment">The comment.</span>
</dl>
<table>
<tr>
<td>Prototyped in:
<td colspan=2><span class="cxref-reference-local"><a href="cxref.h.html#file">cxref.h</a></span>
</tr>
<tr>
<td>Calls:
<td><span class="cxref-reference-local"><a href="memory.c.html#func-SafeRealloc">SafeRealloc()</a></span>
<td><span class="cxref-reference-local"><a href="memory.c.html#func-SafeRealloc">memory.c</a></span>
</tr>
<tr>
<td>
<td colspan=2><span class="cxref-reference-system">strcpy(), strlen()</span>
</tr>
<tr>
<td>Called by:
<td><span class="cxref-reference-local"><a href="preproc.c.html#func-SeenFileChange">SeenFileChange()</a></span>
<td><span class="cxref-reference-local"><a href="preproc.c.html#func-SeenFileChange">preproc.c</a></span>
</tr>
<tr>
<td>
<td><span class="cxref-reference-local"><a href="parse-yacc.c.html#func-yyparse">yyparse()</a></span>
<td><span class="cxref-reference-local"><a href="parse-yacc.c.html#func-yyparse">parse-yacc.c</a></span>
</tr>
<tr>
<td>References Variables:
<td><span class="cxref-reference-local"><a href="comment.c.html#var-current_comment">current_comment</a></span>
<td><span class="cxref-reference-local"><a href="comment.c.html#var-current_comment">comment.c</a></span>
</tr>
<tr>
<td>
<td><span class="cxref-reference-local"><a href="comment.c.html#var-malloc_comment">malloc_comment</a></span>
<td><span class="cxref-reference-local"><a href="comment.c.html#var-malloc_comment">comment.c</a></span>
</tr>
</table>
<hr>
<h2><a name="func-SplitComment">Global Function SplitComment()</a></h2>
<span class="cxref-function-comment"> A function to split out the arguments etc from a comment,
for example the function argument comments are separated using this.</span>
<p>
<tt><span class="cxref-function"><a href="comment.c.src.html#line189">char* SplitComment ( char** original, char* name )</a></span></tt><br>
<dl compact>
<dt><tt><span class="cxref-function">char* SplitComment</span></tt>
<dd><span class="cxref-function-comment">Returns the required comment.</span>
<dt><tt><span class="cxref-function">char** original</span></tt>
<dd><span class="cxref-function-comment">A pointer to the original comment, this is altered in the process.</span>
<dt><tt><span class="cxref-function">char* name</span></tt>
<dd><span class="cxref-function-comment">The name that is to be cut out from the comment.</span>
</dl>
<span class="cxref-function-comment"> A most clever function that ignores spaces so that 'char* b' and 'char *b' match.</span>
<p>
<table>
<tr>
<td>Prototyped in:
<td colspan=2><span class="cxref-reference-local"><a href="cxref.h.html#file">cxref.h</a></span>
</tr>
<tr>
<td>Calls:
<td><span class="cxref-reference-local"><a href="memory.c.html#func-ConcatStrings">ConcatStrings()</a></span>
<td><span class="cxref-reference-local"><a href="memory.c.html#func-ConcatStrings">memory.c</a></span>
</tr>
<tr>
<td>
<td><span class="cxref-reference-local"><a href="memory.c.html#func-CopyString">CopyString()</a></span>
<td><span class="cxref-reference-local"><a href="memory.c.html#func-CopyString">memory.c</a></span>
</tr>
<tr>
<td>
<td><span class="cxref-reference-local"><a href="memory.c.html#func-SafeFree">SafeFree()</a></span>
<td><span class="cxref-reference-local"><a href="memory.c.html#func-SafeFree">memory.c</a></span>
</tr>
<tr>
<td>
<td><span class="cxref-reference-local"><a href="memory.c.html#func-SafeMallocString">SafeMallocString()</a></span>
<td><span class="cxref-reference-local"><a href="memory.c.html#func-SafeMallocString">memory.c</a></span>
</tr>
<tr>
<td>
<td><span class="cxref-reference-local"><a href="comment.c.html#func-TidyCommentString">TidyCommentString()</a></span>
<td><span class="cxref-reference-local"><a href="comment.c.html#func-TidyCommentString">comment.c</a></span>
</tr>
<tr>
<td>
<td colspan=2><span class="cxref-reference-system">strlen(), strstr()</span>
</tr>
<tr>
<td>Called by:
<td><span class="cxref-reference-local"><a href="preproc.c.html#func-SeenDefineFunctionArg">SeenDefineFunctionArg()</a></span>
<td><span class="cxref-reference-local"><a href="preproc.c.html#func-SeenDefineFunctionArg">preproc.c</a></span>
</tr>
<tr>
<td>
<td><span class="cxref-reference-local"><a href="func.c.html#func-SeenFunctionArg">SeenFunctionArg()</a></span>
<td><span class="cxref-reference-local"><a href="func.c.html#func-SeenFunctionArg">func.c</a></span>
</tr>
<tr>
<td>
<td><span class="cxref-reference-local"><a href="func.c.html#func-SeenFunctionDefinition">SeenFunctionDefinition()</a></span>
<td><span class="cxref-reference-local"><a href="func.c.html#func-SeenFunctionDefinition">func.c</a></span>
</tr>
</table>
<hr>
<h2><a name="func-TidyCommentString">Local Function TidyCommentString()</a></h2>
<span class="cxref-function-comment"> Tidy up the current comment string by snipping off trailing and leading junk.</span>
<p>
<tt><span class="cxref-function"><a href="comment.c.src.html#line258">static void TidyCommentString ( char** string, int spaces )</a></span></tt><br>
<dl compact>
<dt><tt><span class="cxref-function">char** string</span></tt>
<dd><span class="cxref-function-comment">The string that is to be tidied.</span>
<dt><tt><span class="cxref-function">int spaces</span></tt>
<dd><span class="cxref-function-comment">Indicates that leading and trailing whitespace are to be removed as well.</span>
</dl>
<table>
<tr>
<td>Prototyped in:
<td colspan=2><span class="cxref-reference-local"><a href="comment.c.html#file">comment.c</a></span>
</tr>
<tr>
<td>Calls:
<td colspan=2><span class="cxref-reference-system">strlen()</span>
</tr>
<tr>
<td>Called by:
<td><span class="cxref-reference-local"><a href="comment.c.html#func-SeenComment">SeenComment()</a></span>
<td><span class="cxref-reference-local"><a href="comment.c.html#func-SeenComment">comment.c</a></span>
</tr>
<tr>
<td>
<td><span class="cxref-reference-local"><a href="comment.c.html#func-SplitComment">SplitComment()</a></span>
<td><span class="cxref-reference-local"><a href="comment.c.html#func-SplitComment">comment.c</a></span>
</tr>
</table>
</BODY>
</HTML>
|