c2man

1 definition found

c2man - Free On-line Dictionary of Computing (26 May 2007) :

  c2man
  
     <tool> An automatic documentation extraction tool by Graham
     Stoney.  c2man extracts comments from C source code to
     generate functional interface documentation in the same format
     as sections 2 and 3 of the Unix Programmer's Manual.  It
     looks for comments near the objects they document, rather than
     imposing a rigid syntax or requiring the programmer to use a
     typesetting language.  Acceptable documentation can often be
     generated from existing code with no modifications.
  
     c2man supports both K&R and ISO/ANSI C coding styles.
     Output can be in nroff -man, Texinfo or LaTeX format.
     It automagically documents enum parameter and return
     values, it handles both C (/* */) and C++ (//) style
     comments, but not C++ grammar (yet).  It requires yacc,
     byacc or bison for syntax analysis; lex or flex for
     lexical analysis and nroff, groff, texinfo or LaTeX
     to format the output.  It runs under Unix, OS/2 and
     MS-DOS.
  
     Version 2.0 patchlevel 25 (1995-10-25).
  
     Washington FTP (ftp://ftp.wustl.edu/usenet/comp.sources.reviewed/volume03/)
     .
     Stuttgart FTP  (ftp://ftp.informatik.uni-stuttgart.de/pub/archive/comp.sources/reviewed/)
      .
     Patches (ftp://lth.se/pub/netnews/sources.bugs/volume93/sep/)
     .
  
     Patches posted to Usenet newsgroups news:comp.sources.bugs
     and news:comp.sources.reviewed.
  
     (2003-05-02)