diff options
authorMu Qiao <qiaomuf@gentoo.org>2011-08-04 16:37:32 +0800
committerMu Qiao <qiaomuf@gentoo.org>2011-08-04 22:15:15 +0800
commit571c24a30cbe087b23b3429dd44281083076c29a (patch)
parentDoc: create a doc folder for libbash documentation (diff)
Doc: add doxygen main page
2 files changed, 13 insertions, 2 deletions
diff --git a/Doxyfile b/Doxyfile
index 9d070e4..69c9a10 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -581,7 +581,7 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
-INPUT = src include
+INPUT = src include doc
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
@@ -598,7 +598,7 @@ INPUT_ENCODING = UTF-8
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
+FILE_PATTERNS = *.cpp *.h *.hpp *.doxygen
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
# should be searched for input files as well. Possible values are YES and NO.
diff --git a/doc/main_page.doxygen b/doc/main_page.doxygen
new file mode 100644
index 0000000..35b2b58
--- /dev/null
+++ b/doc/main_page.doxygen
@@ -0,0 +1,11 @@
+/** \mainpage
+This is the libbash API documentation.
+To find your way around:
+- have a look at the API: <a href="namespacelibbash.html">libbash namespace</a>
+- learn how to use the API by example (source code under utils/)
+- find out what syntax we support now (scripts under scripts/)