tool: c2man


Language:
C, nroff, texinfo, latex, html
Version:
2.0 patchlevel 34
Parts:
documentation generator (C -> nroff -man, -> texinfo, -> latex,
-
> html)
Author:
Graham Stoney <greyham@research.canon.oz.au>
Location:
ftp from any comp.sources.misc archive, in volume42 (the version in the comp.sources.reviewed archive is obsolete) ftp://dnpap.et.tudelft.nl/pub/Unix/Util/c2man-2.0.*.tar.gz
australia:
ftp://archie.au/usenet/comp.sources.misc/volume42/c2man-2.0/*
n.america:
ftp://ftp.wustl.edu/usenet/comp.sources.misc/volume42/c2man-2.0/*
europe:
ftp://ftp.irisa.fr/News/comp.sources.misc/volume42/c2man-2.0/*
japan:
ftp://ftp.iij.ad.jp/pub/NetNews/comp.sources.misc/volume42/c2man-2.0/*
patches:
ftp://lth.se/pub/netnews/sources.bugs/volume93/sep/c2man*
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 or HTML format
+
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 (yet)
Requires:
yacc/byacc/bison, lex/flex, and nroff/groff/texinfo/LaTeX.
Ports:
Unix, OS/2, MSDOS, VMS.
Portability:
very high for unix, via Configure
Status:
actively developed; contributions by users are encouraged.
Discussion:
via a mailing list: send "subscribe c2man <Your Name>" (in the message body) to listserv@research.canon.oz.au
Help:
from the author and other users on the mailing list: c2man@research.canon.oz.au
Announcements:
patches appear first in comp.sources.bugs, and then in comp.sources.misc.
Updated:
March 2nd, 1995

Related Items

language: C

category: C variants summary, or expanded.

category: compiled, imperative languages summary, or expanded.

category: compiler frontend/backend glue summary, or expanded.

category: document formatting languages summary, or expanded.

category: educational summary, or expanded.

category: graphic user interface support summary, or expanded.

language: html

language: latex

language: nroff

category: programming in the large summary, or expanded.

category: terminal graphics support summary, or expanded.

language: texinfo

category: unix tool building summary, or expanded.


This work supported by Idiom Consulting. Idiom is a full-service ISP, providing Internet access in Northern California and Web hosting worldwide.

Please send updates to free-compilers@idiom.com

The HTML is maintained by David Muir Sharnoff and the entries themselves are currently maintained by Bryan Miller.

Copyright (c) 1992-1998 David Muir Sharnoff, All Rights Reserved
Copyright (c) 1994-1996, Steven Allen Robenalt, All Rights Reserved