diff options
| author | Joel Bodenmann <joel@unormal.org> | 2012-11-07 10:32:07 +0100 |
|---|---|---|
| committer | Joel Bodenmann <joel@unormal.org> | 2012-11-07 10:32:07 +0100 |
| commit | 89baca2ef67b57b35e8df895ea952fac0b60fe19 (patch) | |
| tree | 42f09003adcf8026db9a55aa9fff2cd15d8b2547 /docs/src | |
| parent | 17857d6e97429a34fc157270d5425528bab6a031 (diff) | |
| download | uGFX-89baca2ef67b57b35e8df895ea952fac0b60fe19.tar.gz uGFX-89baca2ef67b57b35e8df895ea952fac0b60fe19.tar.bz2 uGFX-89baca2ef67b57b35e8df895ea952fac0b60fe19.zip | |
more doxygen
Diffstat (limited to 'docs/src')
| -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 | 25 | ||||
| -rw-r--r-- | docs/src/touchpad.dox | 26 |
5 files changed, 133 insertions, 0 deletions
diff --git a/docs/src/console.dox b/docs/src/console.dox new file mode 100644 index 00000000..e9b90fd4 --- /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.
+ * 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..974800d0 --- /dev/null +++ b/docs/src/gwin.dox @@ -0,0 +1,25 @@ +/*
+ 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.
+ */
+
diff --git a/docs/src/touchpad.dox b/docs/src/touchpad.dox new file mode 100644 index 00000000..9c156c46 --- /dev/null +++ b/docs/src/touchpad.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 TOUCHPAD
+ * @details The TOUCHPAD module provides high level abstraction to interface
+ * touchscreens.
+ */
+
|