aboutsummaryrefslogtreecommitdiff
path: root/devel/ccdoc/pkg-descr
diff options
context:
space:
mode:
authorDirk Meyer <dinoex@FreeBSD.org>2001-03-14 16:24:40 +0000
committerDirk Meyer <dinoex@FreeBSD.org>2001-03-14 16:24:40 +0000
commit85b76746141d2c319b348bf4ada655868d963d80 (patch)
treea107f1acd2cef3e12813ef0fa26573e7021fb97e /devel/ccdoc/pkg-descr
parent405f149c23a7e560f72789651e94f0d880871573 (diff)
Notes
Diffstat (limited to 'devel/ccdoc/pkg-descr')
-rw-r--r--devel/ccdoc/pkg-descr17
1 files changed, 17 insertions, 0 deletions
diff --git a/devel/ccdoc/pkg-descr b/devel/ccdoc/pkg-descr
new file mode 100644
index 000000000000..60ca14d15fcd
--- /dev/null
+++ b/devel/ccdoc/pkg-descr
@@ -0,0 +1,17 @@
+Ccdoc is a tool for extracting comments from C++ source code and presenting it
+in HTML format, very similar to Java's JavaDoc tool. The tagging used in ccdoc
+is very similar to that of Javadoc, with adaptations for the C++ specifics, of
+course. Ccdoc supports extracting comments from both header and implementation
+files.
+
+In contrast to most other C++ doc'ing applications, ccdoc analyses the code
+before it has been run through the pre-processor, so things such as macros can
+actually be included in the documentation.
+
+It's usage is not quite as straight forward as JavaDoc's, but considering the
+quality of the output, it is well worth the effort.
+
+WWW: http://www.joelinoff.com/ccdoc/
+
+- LoneWolf
+lonewolf@flame.org