aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
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)
treeff25ea20cdd68d3c52ff2beb3775811ff407a3ce /doc
parentDoc: create a doc folder for libbash documentation (diff)
downloadlibbash-571c24a30cbe087b23b3429dd44281083076c29a.tar.gz
libbash-571c24a30cbe087b23b3429dd44281083076c29a.tar.bz2
libbash-571c24a30cbe087b23b3429dd44281083076c29a.zip
Doc: add doxygen main page
Diffstat (limited to 'doc')
-rw-r--r--doc/main_page.doxygen11
1 files changed, 11 insertions, 0 deletions
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/)
+
+*/