home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / programming / c / c2man-2.0pl33.lha / c2man-2.0 / manpage.h < prev    next >
Encoding:
C/C++ Source or Header  |  1995-01-14  |  1.4 KB  |  65 lines
  1. /* $Id: manpage.h,v 2.0.1.5 1993/11/08 00:01:38 greyham Exp $
  2.  * stuff to do with manual page outputing
  3.  */
  4. #ifndef MANPAGE_H
  5. #define MANPAGE_H
  6.  
  7. #include "c2man.h"
  8.  
  9. typedef struct Section Section;
  10. struct Section
  11. {
  12.     Section *next;
  13.     char *name;
  14.     char *text;
  15.     boolean been_output;
  16. };
  17.  
  18. typedef struct ManualPage ManualPage;
  19. struct ManualPage
  20. {
  21.     DeclSpec *decl_spec;
  22.     Declarator *declarator;
  23.     ManualPage *next;
  24.     Section *first_section;
  25.     char *description;
  26.     char *returns;
  27.     char *sourcefile;
  28.     Time_t sourcetime;
  29. };
  30.  
  31. enum LinkType
  32. {
  33. #ifdef HAS_LINK
  34.     LINK_HARD,    /* filesystem hard link */
  35. #endif
  36. #ifdef HAS_SYMLINK
  37.     LINK_SOFT,    /* filesystem soft link */
  38. #endif
  39.     LINK_FILE,    /* nroff file with .so directive */
  40.     LINK_NONE,    /* don't create extra links for it */
  41.     LINK_REMOVE    /* don't create extra links & remove existing ones */
  42. };
  43.  
  44. /* list of manual pages */
  45. extern ManualPage *firstpage;
  46.  
  47. void
  48. new_manual_page _((char *comment, DeclSpec *decl_spec, Declarator *declarator));
  49.  
  50. /* remember the terse description from the first comment in a file */
  51. void remember_terse _((char *comment));
  52.  
  53. void output_manual_pages _((ManualPage *first, int num_input_files,
  54.     enum LinkType link_type));
  55.  
  56. void free_manual_pages _((ManualPage *first));
  57.  
  58. void output_format_string _((const char *fmt));
  59.  
  60. void output_warning _((void));
  61.  
  62. void output_comment _((const char *comment));
  63.  
  64. #endif
  65.