From 66922e0fcbc1a9fd7c2bcc45193b49dacfdc9781 Mon Sep 17 00:00:00 2001 From: Joel Bodenmann Date: Sat, 3 Nov 2012 15:48:26 +0100 Subject: yes sir, please give us even more doxygen --- docs/src/main.dox | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 docs/src/main.dox (limited to 'docs/src') 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 + + 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 . +*/ + +/** + * @mainpage ChibiOS/GFX + * @author Joel Bodenmann (joel@unormal.org). + * + *

ChibiOS/GFX

+ * ChibiOS/GFX is an official add-on library for ChibiOS/RT to + * interface all different types of LCDs and touchscreens. + * + *

Features

+ * - 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 + */ + -- cgit v1.2.3 From fa5ea7915073d42992c0cf91de6d4733633e1535 Mon Sep 17 00:00:00 2001 From: Joel Bodenmann Date: Sat, 3 Nov 2012 21:03:29 +0100 Subject: cleanup of doxygen --- docs/src/main.dox | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/src') diff --git a/docs/src/main.dox b/docs/src/main.dox index 15746925..8810abd0 100644 --- a/docs/src/main.dox +++ b/docs/src/main.dox @@ -27,8 +27,8 @@ * interface all different types of LCDs and touchscreens. * *

Features

- * - modular design to reduce memory footprint. - * - HAL abstractions allows it to easily write new drivers. + * - 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 -- cgit v1.2.3 From 89baca2ef67b57b35e8df895ea952fac0b60fe19 Mon Sep 17 00:00:00 2001 From: Joel Bodenmann Date: Wed, 7 Nov 2012 10:32:07 +0100 Subject: more doxygen --- docs/src/console.dox | 28 ++++++++++++++++++++++++++++ docs/src/gdisp.dox | 26 ++++++++++++++++++++++++++ docs/src/graph.dox | 28 ++++++++++++++++++++++++++++ docs/src/gwin.dox | 25 +++++++++++++++++++++++++ docs/src/touchpad.dox | 26 ++++++++++++++++++++++++++ 5 files changed, 133 insertions(+) create mode 100644 docs/src/console.dox create mode 100644 docs/src/gdisp.dox create mode 100644 docs/src/graph.dox create mode 100644 docs/src/gwin.dox create mode 100644 docs/src/touchpad.dox (limited to 'docs/src') 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 + + 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 . +*/ + +/** + * @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 + + 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 . +*/ + +/** + * @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 + + 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 . +*/ + +/** + * @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 + + 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 . +*/ + +/** + * @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 + + 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 . +*/ + +/** + * @addtogroup TOUCHPAD + * @details The TOUCHPAD module provides high level abstraction to interface + * touchscreens. + */ + -- cgit v1.2.3 From 0458a02b762abdf5d52b8533f53ee1d1b0fa034c Mon Sep 17 00:00:00 2001 From: Joel Bodenmann Date: Wed, 7 Nov 2012 10:48:28 +0100 Subject: a bit more doxygen --- docs/src/console.dox | 2 +- docs/src/gwin.dox | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) (limited to 'docs/src') diff --git a/docs/src/console.dox b/docs/src/console.dox index e9b90fd4..b0721e8a 100644 --- a/docs/src/console.dox +++ b/docs/src/console.dox @@ -23,6 +23,6 @@ * @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 + * @details Read more here: http://chibios-gfx.com/documentation/console */ diff --git a/docs/src/gwin.dox b/docs/src/gwin.dox index 974800d0..b8ea478a 100644 --- a/docs/src/gwin.dox +++ b/docs/src/gwin.dox @@ -20,6 +20,8 @@ /** * @addtogroup GWIN - * @details The GWIN module provides simple window management. + * @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. */ -- cgit v1.2.3 From 87b6d98055afff7c46bd6bdd7db7ba7c1d8e7a57 Mon Sep 17 00:00:00 2001 From: Joel Bodenmann Date: Sat, 10 Nov 2012 00:05:01 +0100 Subject: renamed touchpad into touchscreen --- docs/src/touchpad.dox | 26 -------------------------- 1 file changed, 26 deletions(-) delete mode 100644 docs/src/touchpad.dox (limited to 'docs/src') diff --git a/docs/src/touchpad.dox b/docs/src/touchpad.dox deleted file mode 100644 index 9c156c46..00000000 --- a/docs/src/touchpad.dox +++ /dev/null @@ -1,26 +0,0 @@ -/* - ChibiOS/GFX - Copyright (C) 2012 - Joel Bodenmann aka Tectu - - 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 . -*/ - -/** - * @addtogroup TOUCHPAD - * @details The TOUCHPAD module provides high level abstraction to interface - * touchscreens. - */ - -- cgit v1.2.3 From affd9792ff42fab8f376bd2c87a71b25fd52baf7 Mon Sep 17 00:00:00 2001 From: Joel Bodenmann Date: Sat, 10 Nov 2012 00:13:42 +0100 Subject: added touchscreen files --- docs/src/touchscreen.dox | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 docs/src/touchscreen.dox (limited to 'docs/src') 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 + + 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 . +*/ + +/** + * @addtogroup TOUCHSCREEN + * @details The TOUCHSCREEN module provides high level abstraction to interface + * touchscreens. + */ + -- cgit v1.2.3