1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
|
Source: c2man
Maintainer: Manoj Srivastava <srivasta@debian.org>
Section: devel
Priority: optional
Standards-Version: 3.6.1.0
Build-Depends: sharutils, flex, byacc | bison
Package: c2man
Architecture: any
Depends: ${shlibs:Depends}
Description: Graham Stoney's mechanized man page generator.
Please do not use c2man -- it is unmaintained upstream now, and only
exists because other packages depend on it. Doxygen does a far better
job.
.
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 -- but it
has problems with variable names of type __somename.
.
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
Problems:
* doesn't handle C++ grammar (yet)
* doxygen does this job better
|
