language: C, nroff, texinfo, latex, html, autodoc
package: c2man
version: 2.0 patchlevel 42
parts: documentation generator (C -> nroff -man, -> texinfo, -> latex,
-> html, -> autodoc, -> ASCII)
author: Graham Stoney
location: ftp source and patches from any comp.sources.misc archive.
(the version in the comp.sources.reviewed archive is obsolete)
package: ftp://ftp.research.canon.com.au/pub/misc/c2man/c2man.tar.gz
patches: ftp://ftp.research.canon.com.au/pub/misc/c2man/patches/
description: c2man is an automatic documentation tool that extracts comments
from C source code to generate functional interface
documentation in the same format as sections 2 & 3 of the Unix
Programmer's Manual. It requires minimal effort from the
programmer by looking for comments in the usual places near the
objects they document, rather than imposing a rigid
function-comment syntax or requiring that the programmer learn
and use a typesetting language. Acceptable documentation can
often be generated from existing code with no modifications.
conformance: supports both K&R and ISO/ANSI C coding styles
features: + generates output in nroff -man, TeXinfo, LaTeX, HTML, ASCII.
+ handles comments as part of the language grammar
+ automagically documents enum parameter & return values
+ handles C (/* */) and C++ (//) style comments
- doesn't handle C++ grammar
requires: yacc/byacc/bison, lex/flex, and nroff/groff/texinfo/LaTeX.
ports: Unix, OS/2, MSDOS, VMS, Amiga.
portability: very high for unix, via Configure
status: user-supported; contributions by users are encouraged.
discussion: c2man mailing list: send "subscribe c2man" (in the message
body) to majordomo@research.canon.com.au
help: from the author and other users on the mailing list:
c2man@research.canon.com.au (best to subscribe first though).
announcements: patches appear first in comp.sources.bugs, and then in
comp.sources.misc.
updated: 2000/02/25