diff options
author | Andrew Hannam <andrewh@inmarket.com.au> | 2012-11-09 18:47:05 -0800 |
---|---|---|
committer | Andrew Hannam <andrewh@inmarket.com.au> | 2012-11-09 18:47:05 -0800 |
commit | 0eeb2a2b8f0c6bfb77256522c720e6915d57c217 (patch) | |
tree | 03ce8e6d759d5482185ae4a4797555ac0a922bfa /docs | |
parent | d3b4c499ab0267dbcad3d5972bb0317fdba9043e (diff) | |
parent | affd9792ff42fab8f376bd2c87a71b25fd52baf7 (diff) | |
download | uGFX-0eeb2a2b8f0c6bfb77256522c720e6915d57c217.tar.gz uGFX-0eeb2a2b8f0c6bfb77256522c720e6915d57c217.tar.bz2 uGFX-0eeb2a2b8f0c6bfb77256522c720e6915d57c217.zip |
Merge pull request #1 from Tectu/master
Included Tectu changes
Diffstat (limited to 'docs')
-rw-r--r-- | docs/rsc/layout.xml | 184 | ||||
-rw-r--r-- | docs/src/console.dox | 28 | ||||
-rw-r--r-- | docs/src/gdisp.dox | 26 | ||||
-rw-r--r-- | docs/src/graph.dox | 28 | ||||
-rw-r--r-- | docs/src/gwin.dox | 27 | ||||
-rw-r--r-- | docs/src/main.dox | 37 | ||||
-rw-r--r-- | docs/src/touchscreen.dox | 26 |
7 files changed, 356 insertions, 0 deletions
diff --git a/docs/rsc/layout.xml b/docs/rsc/layout.xml new file mode 100644 index 00000000..a3cadb4f --- /dev/null +++ b/docs/rsc/layout.xml @@ -0,0 +1,184 @@ +<doxygenlayout version="1.0"> + <!-- Navigation index tabs for HTML output --> + <navindex> + <tab type="mainpage" visible="yes" title=""/> + <tab type="pages" visible="yes" title="" intro=""/> + <tab type="modules" visible="yes" title="" intro=""/> + <tab type="namespaces" visible="yes" title=""> + <tab type="namespaces" visible="yes" title="" intro=""/> + <tab type="namespacemembers" visible="yes" title="" intro=""/> + </tab> + <tab type="classes" visible="yes" title=""> + <tab type="classes" visible="yes" title="" intro=""/> + <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/> + <tab type="hierarchy" visible="yes" title="" intro=""/> + <tab type="classmembers" visible="yes" title="" intro=""/> + </tab> + <tab type="files" visible="yes" title=""> + <tab type="files" visible="yes" title="" intro=""/> + <tab type="globals" visible="yes" title="" intro=""/> + </tab> + <!--<tab type="dirs" visible="yes" title="" intro=""/>--> + <tab type="examples" visible="yes" title="" intro=""/> + </navindex> + + <!-- Layout definition for a class page --> + <class> + <briefdescription visible="no"/> + <detaileddescription title=""/> + <includes visible="$SHOW_INCLUDE_FILES"/> + <inheritancegraph visible="$CLASS_GRAPH"/> + <collaborationgraph visible="$COLLABORATION_GRAPH"/> + <allmemberslink visible="yes"/> + <memberdecl> + <nestedclasses visible="yes" title=""/> + <publictypes title=""/> + <publicslots title=""/> + <signals title=""/> + <publicmethods title=""/> + <publicstaticmethods title=""/> + <publicattributes title=""/> + <publicstaticattributes title=""/> + <protectedtypes title=""/> + <protectedslots title=""/> + <protectedmethods title=""/> + <protectedstaticmethods title=""/> + <protectedattributes title=""/> + <protectedstaticattributes title=""/> + <packagetypes title=""/> + <packagemethods title=""/> + <packagestaticmethods title=""/> + <packageattributes title=""/> + <packagestaticattributes title=""/> + <properties title=""/> + <events title=""/> + <privatetypes title=""/> + <privateslots title=""/> + <privatemethods title=""/> + <privatestaticmethods title=""/> + <privateattributes title=""/> + <privatestaticattributes title=""/> + <friends title=""/> + <related title="" subtitle=""/> + <membergroups visible="yes"/> + </memberdecl> + <memberdef> + <typedefs title=""/> + <enums title=""/> + <constructors title=""/> + <functions title=""/> + <related title=""/> + <variables title=""/> + <properties title=""/> + <events title=""/> + </memberdef> + <usedfiles visible="$SHOW_USED_FILES"/> + <authorsection visible="yes"/> + </class> + + <!-- Layout definition for a namespace page --> + <namespace> + <briefdescription visible="no"/> + <detaileddescription title=""/> + <memberdecl> + <nestednamespaces visible="yes" title=""/> + <classes visible="yes" title=""/> + <typedefs title=""/> + <enums title=""/> + <functions title=""/> + <variables title=""/> + <membergroups visible="yes"/> + </memberdecl> + <memberdef> + <typedefs title=""/> + <enums title=""/> + <functions title=""/> + <variables title=""/> + </memberdef> + <authorsection visible="yes"/> + </namespace> + + <!-- Layout definition for a file page --> + <file> + <briefdescription visible="no"/> + <detaileddescription title=""/> + <includes visible="$SHOW_INCLUDE_FILES"/> + <includegraph visible="$INCLUDE_GRAPH"/> + <includedbygraph visible="$INCLUDED_BY_GRAPH"/> + <sourcelink visible="yes"/> + <memberdecl> + <classes visible="yes" title=""/> + <namespaces visible="yes" title=""/> + <functions title=""/> + <variables title=""/> + <defines title=""/> + <typedefs title=""/> + <enums title=""/> + <membergroups visible="yes"/> + </memberdecl> + <memberdef> + <functions title=""/> + <variables title=""/> + <defines title=""/> + <typedefs title=""/> + <enums title=""/> + </memberdef> + <authorsection/> + </file> + + <!-- Layout definition for a group page --> + <group> + <briefdescription visible="no"/> + <groupgraph visible="$GROUP_GRAPHS"/> + <detaileddescription title=""/> + <memberdecl> + <classes visible="yes" title=""/> + <namespaces visible="yes" title=""/> + <dirs visible="yes" title=""/> + <nestedgroups visible="yes" title=""/> + <files visible="yes" title=""/> + <functions title=""/> + <variables title=""/> + <membergroups visible="yes"/> + <defines title=""/> + <typedefs title=""/> + <enums title=""/> + <enumvalues title=""/> + <signals title=""/> + <publicslots title=""/> + <protectedslots title=""/> + <privateslots title=""/> + <events title=""/> + <properties title=""/> + <friends title=""/> + </memberdecl> + <memberdef> + <pagedocs/> + <functions title=""/> + <variables title=""/> + <defines title=""/> + <typedefs title=""/> + <enums title=""/> + <enumvalues title=""/> + <signals title=""/> + <publicslots title=""/> + <protectedslots title=""/> + <privateslots title=""/> + <events title=""/> + <properties title=""/> + <friends title=""/> + </memberdef> + <authorsection visible="yes"/> + </group> + + <!-- Layout definition for a directory page --> + <directory> + <briefdescription visible="no"/> + <directorygraph visible="yes"/> + <detaileddescription title=""/> + <memberdecl> + <dirs visible="yes"/> + <files visible="yes"/> + </memberdecl> + </directory> +</doxygenlayout> diff --git a/docs/src/console.dox b/docs/src/console.dox new file mode 100644 index 00000000..b0721e8a --- /dev/null +++ b/docs/src/console.dox @@ -0,0 +1,28 @@ +/*
+ 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/>.
+*/
+
+/**
+ * @addtogroup CONSOLE
+ * @details The CONSOLE module provides a BaseSequentialStream abstraction.
+ * It allows to easily use an LCD to output any generic data, for
+ * example by using the chprintf() provided by ChibiOS/RT.
+ * @details Read more here: http://chibios-gfx.com/documentation/console
+ */
+
diff --git a/docs/src/gdisp.dox b/docs/src/gdisp.dox new file mode 100644 index 00000000..0fdeae34 --- /dev/null +++ b/docs/src/gdisp.dox @@ -0,0 +1,26 @@ +/*
+ 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/>.
+*/
+
+/**
+ * @addtogroup GDISP
+ * @details The GDISP module provides high level abstraction to interface
+ * pixel oriented graphic displays.
+ */
+
diff --git a/docs/src/graph.dox b/docs/src/graph.dox new file mode 100644 index 00000000..b9ca456d --- /dev/null +++ b/docs/src/graph.dox @@ -0,0 +1,28 @@ +/*
+ 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/>.
+*/
+
+/**
+ * @addtogroup GRAPH
+ * @details The GRAPH module provides high level HAL independed routines
+ * to draw graphs on a graphic display. The graph is highly
+ * configurable. There are many options to controll the look
+ * of the graph.
+ */
+
diff --git a/docs/src/gwin.dox b/docs/src/gwin.dox new file mode 100644 index 00000000..b8ea478a --- /dev/null +++ b/docs/src/gwin.dox @@ -0,0 +1,27 @@ +/*
+ 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/>.
+*/
+
+/**
+ * @addtogroup GWIN
+ * @details The GWIN module provides simple window management.
+ * @details Please note that GWIN is a module ontop of GDISP. Therefore, GDISP
+ * has to be set up correctly.
+ */
+
diff --git a/docs/src/main.dox b/docs/src/main.dox new file mode 100644 index 00000000..8810abd0 --- /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
+ */
+
diff --git a/docs/src/touchscreen.dox b/docs/src/touchscreen.dox new file mode 100644 index 00000000..0a1819b9 --- /dev/null +++ b/docs/src/touchscreen.dox @@ -0,0 +1,26 @@ +/*
+ 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/>.
+*/
+
+/**
+ * @addtogroup TOUCHSCREEN
+ * @details The TOUCHSCREEN module provides high level abstraction to interface
+ * touchscreens.
+ */
+
|