summaryrefslogtreecommitdiff
path: root/INSTALL
diff options
context:
space:
mode:
authorKlaus Schmidinger <vdr@tvdr.de>2002-12-15 15:36:02 +0100
committerKlaus Schmidinger <vdr@tvdr.de>2002-12-15 15:36:02 +0100
commitc7849b14a7502f626f9cf806e998a711b28fb21b (patch)
tree2de1a4874285a8cc6d7217c9f58fdf6f277a19af /INSTALL
parentd610d95e509c04fec7be22f4a7ae2fd308fa53a9 (diff)
downloadvdr-c7849b14a7502f626f9cf806e998a711b28fb21b.tar.gz
vdr-c7849b14a7502f626f9cf806e998a711b28fb21b.tar.bz2
Using 'Doxygen' to generate source code documentation
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL8
1 files changed, 8 insertions, 0 deletions
diff --git a/INSTALL b/INSTALL
index 8e61605d..ce5420a3 100644
--- a/INSTALL
+++ b/INSTALL
@@ -357,3 +357,11 @@ If you prefer different key assignments, or if the default doesn't work for
your keyboard, simply delete the file 'remote.conf' and restart 'vdr' to get
into learning mode.
+Generating source code documentation:
+-------------------------------------
+
+You can do a 'make srcdoc' to generate source code documentation using the
+Doxygen tool. To do so you need the Doxygen package from http://www.doxygen.src
+and the Graphviz package from http://www.research.att.com/sw/tools/graphviz.
+After installing these two packages you can do 'make srcdoc' and then use your
+HTML browser to read srcdoc/html/index.html.