Initial doxygen control files: doxyfile, README, html header&footer, and nice little graphic.

2010-02-14 06:02:08 +00:00
parent 4cc1ce9c62
commit 786ddffc04
5 changed files with 1403 additions and 0 deletions
@@ -0,0 +1,35 @@
+To build the Doxygen documentation for the BACnet Stack:
+- Install doxygen as described at 
+  http://www.stack.nl/~dimitri/doxygen/install.html
+- If you want to generate call graphs (recommended - very nice! - but takes 
+  signficantly longer to build the documents), you must also have 
+  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!)
+- 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 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 
+  regenerated.
+  
+For speed, the function call graphs are not enabled in the SVN version
+  of the doxyfile.  To enable them, edit BACnet-stack.doxyfile (with a
+  text editor or with GUI-based editors in Eclipse or using the 
+  doxywizard application) and change 
+    HAVE_DOT = YES
+    CALLER_GRAPH = YES
+    
+    
+Following the doxygen website's lead, I found the D-Bus project to be a good 
+  example of the sort of documentation we needed to have here.
+  http://dbus.freedesktop.org/doc/dbus/api/html/index.html
+
+  
@@ -0,0 +1,7 @@
+<hr size="1"/><address style="text-align: right;"><small>
+<img class="footer" src="BACnet_sm.png" alt="BACnet logo"/>
+<!-- Break the small and then resume it -->
+</small><b>BACnet-stack API documentation</b><small><br>
+Generated on $datetime for $projectname by&nbsp;<a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.png" alt="doxygen"/></a> $doxygenversion</small></address>
+</body>
+</html>
@@ -0,0 +1,12 @@
+<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<title>$title</title>
+<link href="$relpath$tabs.css" rel="stylesheet" type="text/css"/>
+<link href="$relpath$search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javaScript" src="$relpath$search/search.js"></script>
+<link href="$relpath$doxygen.css" rel="stylesheet" type="text/css">
+</head>
+<body onload='searchBox.OnSelectItem(0);'>