aboutsummaryrefslogtreecommitdiffstats
path: root/docs/src
diff options
context:
space:
mode:
authorJoel Bodenmann <joel@unormal.org>2012-11-03 15:48:26 +0100
committerJoel Bodenmann <joel@unormal.org>2012-11-03 15:48:26 +0100
commit66922e0fcbc1a9fd7c2bcc45193b49dacfdc9781 (patch)
treefc137d0623e1a81947bde6bc089ed22179f9874a /docs/src
parentbca9c1442e9f498c6946d2984f9944ca7cfb7a6d (diff)
downloaduGFX-66922e0fcbc1a9fd7c2bcc45193b49dacfdc9781.tar.gz
uGFX-66922e0fcbc1a9fd7c2bcc45193b49dacfdc9781.tar.bz2
uGFX-66922e0fcbc1a9fd7c2bcc45193b49dacfdc9781.zip
yes sir, please give us even more doxygen
Diffstat (limited to 'docs/src')
-rw-r--r--docs/src/main.dox37
1 files changed, 37 insertions, 0 deletions
diff --git a/docs/src/main.dox b/docs/src/main.dox
new file mode 100644
index 00000000..15746925
--- /dev/null
+++ b/docs/src/main.dox
@@ -0,0 +1,37 @@
+/*
+ ChibiOS/GFX - Copyright (C) 2012
+ Joel Bodenmann aka Tectu <joel@unormal.org>
+
+ This file is part of ChibiOS/GFX.
+
+ ChibiOS/GFX is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 3 of the License, or
+ (at your option) any later version.
+
+ ChibiOS/GFX is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+/**
+ * @mainpage ChibiOS/GFX
+ * @author Joel Bodenmann (joel@unormal.org).
+ *
+ * <h2>ChibiOS/GFX</h2>
+ * ChibiOS/GFX is an official add-on library for ChibiOS/RT to
+ * interface all different types of LCDs and touchscreens.
+ *
+ * <h2>Features</h2>
+ * - modular design to reduce memory footprint.
+ * - HAL abstractions allows it to easily write new drivers.
+ * - Completely written in C, usable in C++ without any modifications
+ * - Supports hardware accelerated drawing by LCDs
+ * - Very flexible interfaces for calibration storage and more
+ * - We are having our own homepage: http://chibios-gfx.com
+ */
+