home *** CD-ROM | disk | FTP | other *** search
/ NetNews Usenet Archive 1992 #27 / NN_1992_27.iso / spool / alt / sources / patches / 47 < prev    next >
Encoding:
Text File  |  1992-11-21  |  8.4 KB  |  293 lines
  1. Newsgroups: alt.sources.patches
  2. Path: sparky!uunet!munnari.oz.au!metro!mama!greyham
  3. From: greyham@research.canon.oz.au (Graham Stoney)
  4. Subject: c2man: generate man pages from C comments; patch v1.9 -> v1.10
  5. Message-ID: <By08zp.6M4@research.canon.oz.au>
  6. Followup-To: alt.sources.d
  7. Summary: A program to help document C functions with minimal extra effort.
  8. Keywords: c2man, Unix, man, ANSI-C, documentation generator
  9. Sender: news@research.canon.oz.au
  10. Organization: Canon Information Systems Research Australia
  11. Date: Fri, 20 Nov 1992 08:02:13 GMT
  12. Lines: 279
  13.  
  14. Archive-name: c2man/patch.1.9-1.10
  15. Submitted-by: greyham@research.canon.oz.au
  16.  
  17. This official patch brings c2man v1.9 up to v1.10.
  18.  
  19. I wait around and collect a few bug-fixes into the one patch before posting; but
  20. somehow I always get a bug report immediately after every posting!
  21.  
  22. See the CHANGES file for more details.
  23.  
  24. As before, any feedback, comments or tips are greatly appreciated.
  25.  
  26. Graham
  27.  
  28. *** 1.11    1992/11/03 06:17:28
  29. --- CHANGES    1992/11/06 03:25:08
  30. ***************
  31. *** 104,106 ****
  32. --- 104,112 ----
  33.       Don't error on "typedef int NewType; NewType a;"
  34.   
  35.       -Ssection option added by jerry@kesa24.kesa.com (Jerry E. Dunmire).
  36. + 
  37. + Version 1.10:
  38. +     Accept comments around a final ellipsis parameter.
  39. + 
  40. +     Make parameter declarations in the prototype and the PARAMETERS section
  41. +     identical.
  42. *** 1.13    1992/10/15 07:53:08
  43. --- Makefile    1992/11/20 07:55:02
  44. ***************
  45. *** 1,4 ****
  46. ! # $Id: Makefile,v 1.13 1992/10/15 07:53:08 greyham Exp $
  47.   #
  48.   # UNIX makefile for manual page generator
  49.   #
  50. --- 1,4 ----
  51. ! # $Id: Makefile,v 1.14 1992/11/20 07:54:48 greyham Exp $
  52.   #
  53.   # UNIX makefile for manual page generator
  54.   #
  55. ***************
  56. *** 100,106 ****
  57.       $(CC) $(CFLAGS) -o $@ $(OBJECTS) $(LIBS)
  58.   
  59.   y.tab.c: grammar.y
  60. !     @echo Expect 33 shift/reduce conflicts.
  61.       $(YACC) grammar.y
  62.   
  63.   # don't compile y.tab.c with all warnings; yacc/bison are not up to it.
  64. --- 100,106 ----
  65.       $(CC) $(CFLAGS) -o $@ $(OBJECTS) $(LIBS)
  66.   
  67.   y.tab.c: grammar.y
  68. !     @echo Expect 34 shift/reduce conflicts.
  69.       $(YACC) grammar.y
  70.   
  71.   # don't compile y.tab.c with all warnings; yacc/bison are not up to it.
  72. *** 1.10    1992/11/03 06:17:28
  73. --- README    1992/11/06 03:29:16
  74. ***************
  75. *** 1,4 ****
  76. ! This is c2man (Version 1.9), a program for generating Unix style manual pages
  77.   in nroff/troff -man format directly from ordinary comments embedded in C source
  78.   code. It owes a huge debt to the public domain program cproto, by Chin Huang,
  79.   from which much of the code is derived.
  80. --- 1,4 ----
  81. ! This is c2man (Version 1.10), a program for generating Unix style manual pages
  82.   in nroff/troff -man format directly from ordinary comments embedded in C source
  83.   code. It owes a huge debt to the public domain program cproto, by Chin Huang,
  84.   from which much of the code is derived.
  85. *** 1.9    1992/11/03 06:17:28
  86. --- c2man.c    1992/11/20 07:56:13
  87. ***************
  88. *** 1,10 ****
  89. ! /* $Id: c2man.c,v 1.9 1992/11/03 06:17:28 greyham Exp $
  90.    *
  91.    * C Manual page generator.
  92.    * Reads C source code and outputs manual pages.
  93.    */
  94.   #ifndef lint
  95. ! static char *rcsid = "$Id: c2man.c,v 1.9 1992/11/03 06:17:28 greyham Exp $";
  96.   #endif
  97.   #include <stdio.h>
  98.   #include <ctype.h>
  99. --- 1,10 ----
  100. ! /* $Id: c2man.c,v 1.10 1992/11/20 07:56:01 greyham Exp $
  101.    *
  102.    * C Manual page generator.
  103.    * Reads C source code and outputs manual pages.
  104.    */
  105.   #ifndef lint
  106. ! static char *rcsid = "$Id: c2man.c,v 1.10 1992/11/20 07:56:01 greyham Exp $";
  107.   #endif
  108.   #include <stdio.h>
  109.   #include <ctype.h>
  110. *** 1.8    1992/11/03 06:17:28
  111. --- grammar.y    1992/11/20 07:55:14
  112. ***************
  113. *** 1,4 ****
  114. ! /* $Id: grammar.y,v 1.8 1992/11/03 06:17:28 greyham Exp $
  115.    *
  116.    * yacc grammar for C manual page generator
  117.    * This was derived from the grammar given in Appendix A of
  118. --- 1,4 ----
  119. ! /* $Id: grammar.y,v 1.9 1992/11/20 07:54:48 greyham Exp $
  120.    *
  121.    * yacc grammar for C manual page generator
  122.    * This was derived from the grammar given in Appendix A of
  123. ***************
  124. *** 534,542 ****
  125.           $$ = $1;
  126.           if ($2)    comment_last_parameter(&$1, $2);
  127.       }
  128. !     | parameter_list ',' T_ELLIPSIS
  129.       {
  130.           add_ident_list(&$$, &$1, strdup("..."));
  131.       }
  132.       ;
  133.   
  134. --- 534,553 ----
  135.           $$ = $1;
  136.           if ($2)    comment_last_parameter(&$1, $2);
  137.       }
  138. !     | parameter_list ',' opt_eolcomment
  139. !         opt_comment T_ELLIPSIS opt_comment opt_eolcomment
  140.       {
  141. +         if ($3)    comment_last_parameter(&$1, $3);
  142.           add_ident_list(&$$, &$1, strdup("..."));
  143. + 
  144. +         switch (($4 != NULL) + ($6 != NULL) + ($7 != NULL))
  145. +         {
  146. +         case 0:    break;
  147. +         case 1:    comment_last_parameter(&$$, $4 ? $4 : $6 ? $6 : $7);
  148. +             break;
  149. +         default:    yyerror("ellipsis parameter has multiple comments");
  150. +                 break;
  151. +         }
  152.       }
  153.       ;
  154.   
  155. *** 1.12    1992/11/03 06:17:28
  156. --- manpage.c    1992/11/20 07:55:42
  157. ***************
  158. *** 1,4 ****
  159. ! /* $Id: manpage.c,v 1.12 1992/11/03 06:17:28 greyham Exp $
  160.    * stuff to do with manual page outputing
  161.    */
  162.   
  163. --- 1,4 ----
  164. ! /* $Id: manpage.c,v 1.13 1992/11/20 07:54:48 greyham Exp $
  165.    * stuff to do with manual page outputing
  166.    */
  167.   
  168. ***************
  169. *** 179,197 ****
  170.   {
  171.       Parameter *p;
  172.   
  173. -     /* Check for parameter names with no declaration specifiers.  This
  174. -      * happens when a parameter name appears in the identifier list of a
  175. -      * function definition but does not appear in the parameter declaration
  176. -      * part.  The default type in this cause is "int".
  177. -      */
  178. -     for (p = params->first; p != NULL; p = p->next) {
  179. -     if (strlen(p->decl_spec.text) == 0 &&
  180. -         strcmp(p->declarator.text, "...") != 0) {
  181. -         free(p->decl_spec.text);
  182. -         p->decl_spec.text = strdup("int");
  183. -     }
  184. -     }
  185. - 
  186.       for (p = params->first; p != NULL; p = p->next)
  187.       {
  188.       /* use the declarator comment if we can */
  189. --- 179,184 ----
  190. ***************
  191. *** 200,213 ****
  192.       if (p->suppress)    continue;
  193.        
  194.           put_string(".TP\n.BR \"");
  195. !     output_decl_spec(&p->decl_spec);
  196. !     
  197. !     /* not all parameters must have declarators: might be a prototype */
  198. !     if (p->declarator.text)
  199. !     {
  200. !         putchar(' ');
  201. !         output_declarator(&p->declarator, FALSE);    /* all on one line */
  202. !     }
  203.       
  204.       /* include function name if it's a duplicate */
  205.       if (p->duplicate)
  206. --- 187,193 ----
  207.       if (p->suppress)    continue;
  208.        
  209.           put_string(".TP\n.BR \"");
  210. !     output_parameter(p);
  211.       
  212.       /* include function name if it's a duplicate */
  213.       if (p->duplicate)
  214. *** 1.6    1992/08/25 06:41:02
  215. --- semantic.c    1992/11/20 07:55:39
  216. ***************
  217. *** 1,4 ****
  218. ! /* $Id: semantic.c,v 1.6 1992/08/25 06:41:02 greyham Exp $
  219.    *
  220.    * C manual page generator
  221.    * These routines implement the semantic actions executed by the yacc parser.
  222. --- 1,4 ----
  223. ! /* $Id: semantic.c,v 1.7 1992/11/20 07:54:48 greyham Exp $
  224.    *
  225.    * C manual page generator
  226.    * These routines implement the semantic actions executed by the yacc parser.
  227. ***************
  228. *** 468,480 ****
  229.   
  230.   /* Output a function parameter.
  231.    */
  232. ! static void
  233.   output_parameter (p)
  234.   Parameter *p;
  235.   {
  236. !     put_string(p->decl_spec.text);
  237.       if (p->declarator.text) {
  238. !     if (strcmp(p->declarator.text, "...") != 0)
  239.           putchar(' ');
  240.       /* don't format parameters; keep it all on one line */
  241.       output_declarator(&(p->declarator), FALSE);
  242. --- 468,491 ----
  243.   
  244.   /* Output a function parameter.
  245.    */
  246. ! void
  247.   output_parameter (p)
  248.   Parameter *p;
  249.   {
  250. !     if (p->decl_spec.text)
  251. !     put_string(p->decl_spec.text);
  252. !     else
  253. !     /* Check for parameter names with no declaration specifiers.  This
  254. !      * happens when a parameter name appears in the identifier list of a
  255. !      * function definition but does not appear in the parameter declaration
  256. !      * part.  The default type in this cause is "int".
  257. !      */
  258. !     if (p->declarator.text && strcmp(p->declarator.text, "...") != 0)
  259. !     put_string("int ");
  260. ! 
  261. !     /* not all parameters must have declarators: might be a prototype */
  262.       if (p->declarator.text) {
  263. !     if (p->decl_spec.text)
  264.           putchar(' ');
  265.       /* don't format parameters; keep it all on one line */
  266.       output_declarator(&(p->declarator), FALSE);
  267. *** 1.4    1992/08/25 06:41:02
  268. --- semantic.h    1992/11/20 07:55:19
  269. ***************
  270. *** 1,4 ****
  271. ! /* $Id: semantic.h,v 1.4 1992/08/25 06:41:02 greyham Exp $
  272.    *
  273.    * Declarations for semantic action routines
  274.    */
  275. --- 1,4 ----
  276. ! /* $Id: semantic.h,v 1.5 1992/11/20 07:54:48 greyham Exp $
  277.    *
  278.    * Declarations for semantic action routines
  279.    */
  280. ***************
  281. *** 96,101 ****
  282. --- 96,105 ----
  283.       DeclSpec *decl_spec,
  284.       Declarator *declarator
  285.       );
  286. + 
  287. + /* Output a function parameter.*/
  288. + void output_parameter (Parameter *p);
  289. + 
  290.   int
  291.   remember_declarations (
  292.   char *comment,            /* comment associated */
  293.