summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorErik Hallnor <ehallnor@umich.edu>2003-10-07 14:54:10 -0400
committerErik Hallnor <ehallnor@umich.edu>2003-10-07 14:54:10 -0400
commitff883c7e15ed114e9768497af037f181cd165295 (patch)
tree7f3308562ffb775010176101c634e65bb7078440
parent782f18218c3343aa828f67fe5440d5237968170d (diff)
downloadgem5-ff883c7e15ed114e9768497af037f181cd165295.tar.xz
Move documentation pages from html into doxygen. Update Doxyfile to support BitKeeper
Doxyfile: Update this to ignore the BitKeeper directories. Add a custom footer. --HG-- extra : convert_revision : c884d0f65b4c23ab7dd6a59eb6d4a83f398815c5
-rw-r--r--Doxyfile6
-rw-r--r--docs/footer.html6
2 files changed, 9 insertions, 3 deletions
diff --git a/Doxyfile b/Doxyfile
index 3bf57ca71..387bb8f98 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -378,7 +378,7 @@ RECURSIVE = YES
# excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag.
-EXCLUDE = build configs setup */CVS
+EXCLUDE = build configs setup
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
# that are symbolic links (a Unix filesystem feature) are excluded from the input.
@@ -389,7 +389,7 @@ EXCLUDE_SYMLINKS = YES
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
# certain files from those directories.
-EXCLUDE_PATTERNS =
+EXCLUDE_PATTERNS = */BitKeeper/* */Attic/* */SCCS/*
# The EXAMPLE_PATH tag can be used to specify one or more files or
# directories that contain example code fragments that are included (see
@@ -524,7 +524,7 @@ HTML_HEADER =
# each generated HTML page. If it is left blank doxygen will generate a
# standard footer.
-HTML_FOOTER =
+HTML_FOOTER = docs/footer.html
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
# style sheet that is used by each HTML page. It can be used to
diff --git a/docs/footer.html b/docs/footer.html
new file mode 100644
index 000000000..58fa35fb8
--- /dev/null
+++ b/docs/footer.html
@@ -0,0 +1,6 @@
+<hr size="1"><address style="align: right;"><small>
+Generated on $datetime for $projectname by <a href="http://www.doxygen.org/index.html"> doxygen</a> $doxygenversion</small></address>
+<address><a href="mailto:m5-dev@eecs.umich.edu">M5 Development Team</a></address>
+
+</body>
+</html>