aboutsummaryrefslogtreecommitdiff
path: root/devel/c2man/pkg-descr
diff options
context:
space:
mode:
Diffstat (limited to 'devel/c2man/pkg-descr')
-rw-r--r--devel/c2man/pkg-descr9
1 files changed, 9 insertions, 0 deletions
diff --git a/devel/c2man/pkg-descr b/devel/c2man/pkg-descr
new file mode 100644
index 000000000000..012a2ea923b8
--- /dev/null
+++ b/devel/c2man/pkg-descr
@@ -0,0 +1,9 @@
+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.