|
Language:
|
C, nroff, texinfo, latex, html, autodoc
|
|---|
|
Package:
|
c2man
|
|---|
|
Version:
|
2.0 patchlevel 41
|
|---|
|
Parts:
|
documentation generator (C -> nroff -man, -> texinfo, -> latex,
- -
> html, -> autodoc)
|
|---|
|
Author:
|
Graham Stoney <greyham@research.canon.com.au>
|
|---|
|
Location:
|
|
|---|
|
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
|
|---|
|
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
|
|---|
|
Announcements:
|
patches appear first in comp.sources.bugs, and then in
comp.sources.misc.
|
|---|
|
Updated:
|
October 17th, 1996
|
|---|