lotus

previous page: 10.2. c2cweb (Other tools - Literate Programming)
  
page up: Literate Programming FAQ
  
next page: 10.4. cnoweb (Other tools - Literate Programming)

10.3. c2man (Other tools - Literate Programming)




Description

This article is from the Literate Programming FAQ, by David B. Thompson thompson@shelob.ce.ttu.edu with numerous contributions by others.

10.3. c2man (Other tools - Literate Programming)


author:
Graham Stoney <greyham@research.canon.oz.au>
language:
C, nroff, texinfo, latex, html

version:
2.0 patchlevel 33

parts:
documentation generator (C -> nroff -man, -> texinfo, ->latex,
-> html)

location:
ftp from

o any comp.sources.misc archive, in volume42 (the version in the
comp.sources.reviewed archive is obsolete)

o dnpap.et.tudelft.nl/pub/Unix/Util/ c2man-2.0.*.tar.gz

o Australia archie.au/usenet/comp.sources.misc/volume42
c2man-2.0/*

o N.America ftp://ftp.wustl.edu/usenet/comp.sources.misc/2/c2man-2.0/*

o Europe: ftp://ftp.irisa.fr/News/comp.sources.misc/volume42/c2man-2.0/*

o Japan:
ftp://ftp.iij.ad.jp/pub/NetNews/comp.sources.misc/volume42/c2man-2.0/*

Patches:
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:

o generates output in nroff -man, TeXinfo, LaTeX or HTML format

o handles comments as part of the language grammar

o automagically documents enum parameter & return values

o handles C (/* */) and C++ (//) style comments

o 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:
1994/10/07

 

Continue to:













TOP
previous page: 10.2. c2cweb (Other tools - Literate Programming)
  
page up: Literate Programming FAQ
  
next page: 10.4. cnoweb (Other tools - Literate Programming)