summaryrefslogtreecommitdiff
path: root/devel/doxygen/DESCR
diff options
context:
space:
mode:
authorzuntum <zuntum@pkgsrc.org>2001-11-01 00:57:41 +0000
committerzuntum <zuntum@pkgsrc.org>2001-11-01 00:57:41 +0000
commitc72c1cf5f95cbe537b005028f1743cddb16ef203 (patch)
tree93b6296152ccfbaa88b43de043b2d69ce6e63fc5 /devel/doxygen/DESCR
parent37637e483f1bf6574e9306aebbd013bb63d888d6 (diff)
downloadpkgsrc-c72c1cf5f95cbe537b005028f1743cddb16ef203.tar.gz
Move pkg/ files into package's toplevel directory
Diffstat (limited to 'devel/doxygen/DESCR')
-rw-r--r--devel/doxygen/DESCR20
1 files changed, 20 insertions, 0 deletions
diff --git a/devel/doxygen/DESCR b/devel/doxygen/DESCR
new file mode 100644
index 00000000000..91a80afb6a0
--- /dev/null
+++ b/devel/doxygen/DESCR
@@ -0,0 +1,20 @@
+Doxygen is a documentation system for C++, Java, IDL (Corba, Microsoft and
+KDE-DCOP flavors) and C.
+
+It can help you in three ways:
+
+ 1. It can generate an on-line documentation browser (in HTML) and/or an
+ off-line reference manual (in LaTeX) from a set of documented source
+ files. There is also support for generating output in RTF (MS-Word),
+ PostScript, hyperlinked PDF, compressed HTML, and Unix man pages. The
+ documentation is extracted directly from the sources, which makes it
+ much easier to keep the documentation consistent with the source code.
+
+ 2. Doxygen can be configured to extract the code structure from
+ undocumented source files. This can be very useful to quickly find your
+ way in large source distributions. The relations between the various
+ elements are be visualized by means of include dependency graphs,
+ inheritance diagrams, and collaboration diagrams, which are all
+ generated automatically.
+
+ 3. You can even `abuse' doxygen for creating normal documentation