summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorPete Batard <pete@akeo.ie>2012-04-03 13:42:42 +0100
committerPete Batard <pete@akeo.ie>2012-04-03 15:42:13 +0100
commitca159f15737e9097a4d031c9950f281c42af040a (patch)
treee53ec33fe2e40dd5f3eedb661e7177d80e30d437 /doc
parent791b7473ec38155ee3d1d9889f3d0f1b4c8f33f0 (diff)
downloadlibusb-ca159f15737e9097a4d031c9950f281c42af040a.tar.gz
Doc: Update doxygen for libusbx and add logo
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.am3
-rw-r--r--doc/doxygen.cfg.in24
-rw-r--r--doc/libusbx.pngbin0 -> 2923 bytes
3 files changed, 16 insertions, 11 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index ac5b189..544a281 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -5,6 +5,5 @@ docs: doxygen.cfg
docs-upload: docs
ln -s html api-1.0
- rsync -av api-1.0/ dsd_,libusb@web.sourceforge.net:htdocs/api-1.0/
+ scp -r api-1.0 pbatard@web.sourceforge.net:/home/project-web/libusbx/htdocs
rm -f api-1.0
-
diff --git a/doc/doxygen.cfg.in b/doc/doxygen.cfg.in
index 795335c..5fcd683 100644
--- a/doc/doxygen.cfg.in
+++ b/doc/doxygen.cfg.in
@@ -25,13 +25,26 @@ DOXYFILE_ENCODING = UTF-8
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
# by quotes) that should identify the project.
-PROJECT_NAME = libusbx
+PROJECT_NAME =
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or
# if some version control system is used.
-PROJECT_NUMBER =
+PROJECT_NUMBER =
+
+# Using the PROJECT_BRIEF tag one can provide an optional one line description
+# for a project that appears at the top of each page and should give viewer a
+# quick idea about the purpose of the project. Keep the description short.
+
+PROJECT_BRIEF = "eXpand your USB potential"
+
+# With the PROJECT_LOGO tag one can specify an logo or icon that is included
+# in the documentation. The maximum height of the logo should not exceed 55
+# pixels and the maximum width should not exceed 200 pixels. Doxygen will
+# copy the logo to the output directory.
+
+PROJECT_LOGO = libusbx.png
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put.
@@ -154,13 +167,6 @@ QT_AUTOBRIEF = NO
MULTILINE_CPP_IS_BRIEF = NO
-# If the DETAILS_AT_TOP tag is set to YES then Doxygen
-# will output the detailed description near the top, like JavaDoc.
-# If set to NO, the detailed description appears after the member
-# documentation.
-
-DETAILS_AT_TOP = NO
-
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
# member inherits the documentation from any documented member that it
# re-implements.
diff --git a/doc/libusbx.png b/doc/libusbx.png
new file mode 100644
index 0000000..de69d1e
--- /dev/null
+++ b/doc/libusbx.png
Binary files differ