dali/bacnet_stack
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added partial documentation of DS-COV.

Browse Source 
Dropped the Latex output from default doxyfile.
Added a convenience starting point for HTML output, the only format that has worked well for this project on doxygen.
This commit is contained in:
tbrennan3
2010-03-07 05:42:19 +00:00
parent 997a75ecfe
commit 776bf54278
5 changed files with 100 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
bacnet-stack/doc/README.doxygen
+8 -4
View File
@@ -6,18 +6,22 @@ To build the Doxygen documentation for the BACnet Stack:
graphviz installed.
- To build from the command line, just enter
doxygen BACnet-stack.doxyfile
- Output is built in doc/output/html and doc/output/latex
- The Latex output can be converted into a PDF (see doxygen manual,
google, and good luck!)
- Output is built in doc/output/html, and there is a convenient
starting point at doc/output/BAC_stack.html.
- If you use Eclipse,
- install the eClox plugin to support doxygen within Eclipse
- Build the documents by right clicking on BACnet-stack.doxyfile,
and selecting "@ Build Documentation"
- Feel free to tweak the doxygen output to your tastes, interests, and
choice of output formats.
- The Latex output can be converted into a PDF (see doxygen manual,
google, and good luck!)
- I have tried the PDF, man, and RTF outputs and not liked the results
for any of them (500+ pages). I recommend the HTML output, as it is
well organized and has an obvious flow, both of which the others lack.
The doxygen output is not checked into this project because it consists of
over 10,000 little files (for HTML and Latex), and it is easily
over 5,000 little files (for HTML with call graphs), and it is easily
regenerated.
For speed, the function call graphs are not enabled in the SVN version
bacnet-stack/doc/output/BAC_stack.html
+16
View File
@@ -0,0 +1,16 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>BAC-stack</title>
</head>
<frameset cols="250,*">
<frame src="html/tree.html" name="treefrm"/>
<frame src="html/main.html" name="basefrm"/>
<noframes>
<body>
<a href="html/main.html">Frames are disabled. Click here to go to the main page.</a>
</body>
</noframes>
</frameset>
</html>