From e1de308dfabc160f724df51ebebc59bde9717c08 Mon Sep 17 00:00:00 2001 From: Joel Bodenmann Date: Tue, 18 Dec 2012 20:06:10 +0100 Subject: ginput doxygen --- docs/src/touchscreen.dox | 26 -------------------------- 1 file changed, 26 deletions(-) delete mode 100644 docs/src/touchscreen.dox (limited to 'docs/src') diff --git a/docs/src/touchscreen.dox b/docs/src/touchscreen.dox deleted file mode 100644 index 0a1819b9..00000000 --- a/docs/src/touchscreen.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 TOUCHSCREEN - * @details The TOUCHSCREEN module provides high level abstraction to interface - * touchscreens. - */ - -- cgit v1.2.3 From 8bc7b22ce73c16b8975dad57dbff79be2fbf84f8 Mon Sep 17 00:00:00 2001 From: Joel Bodenmann Date: Tue, 18 Dec 2012 22:04:35 +0100 Subject: doxygen --- docs/src/ginput.dox | 27 +++++++++++++++++++++++++++ docs/src/graph.dox | 28 ---------------------------- 2 files changed, 27 insertions(+), 28 deletions(-) create mode 100644 docs/src/ginput.dox delete mode 100644 docs/src/graph.dox (limited to 'docs/src') diff --git a/docs/src/ginput.dox b/docs/src/ginput.dox new file mode 100644 index 00000000..73fbe157 --- /dev/null +++ b/docs/src/ginput.dox @@ -0,0 +1,27 @@ +/* + 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 GINPUT + * + * @details GINPUT provides an easy and common interface to use different + * input devices such as touchscreens and mices. + */ + diff --git a/docs/src/graph.dox b/docs/src/graph.dox deleted file mode 100644 index b9ca456d..00000000 --- a/docs/src/graph.dox +++ /dev/null @@ -1,28 +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 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. - */ - -- cgit v1.2.3 From 5c6027d14d168a7210ed6edd8c8b7506842fd7b0 Mon Sep 17 00:00:00 2001 From: Joel Bodenmann Date: Tue, 18 Dec 2012 22:49:01 +0100 Subject: some more doxygen --- docs/src/gwin.dox | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'docs/src') diff --git a/docs/src/gwin.dox b/docs/src/gwin.dox index b8ea478a..7f5b4115 100644 --- a/docs/src/gwin.dox +++ b/docs/src/gwin.dox @@ -20,7 +20,9 @@ /** * @addtogroup GWIN - * @details The GWIN module provides simple window management. + * @details The GWIN module does not only provides simple window manager, but also + * different widgets such as a console/terminal, buttons and a module + * to draw graphs. * @details Please note that GWIN is a module ontop of GDISP. Therefore, GDISP * has to be set up correctly. */ -- cgit v1.2.3 From a520a32209cc6057b985bde5d0ad21a8f4186bf2 Mon Sep 17 00:00:00 2001 From: Joel Bodenmann Date: Tue, 18 Dec 2012 23:15:47 +0100 Subject: more doxygen --- docs/src/gdisp.dox | 26 -------------------------- docs/src/ginput.dox | 27 --------------------------- docs/src/gtimer.dox | 36 ------------------------------------ docs/src/gwin.dox | 29 ----------------------------- 4 files changed, 118 deletions(-) delete mode 100644 docs/src/gdisp.dox delete mode 100644 docs/src/ginput.dox delete mode 100644 docs/src/gtimer.dox delete mode 100644 docs/src/gwin.dox (limited to 'docs/src') diff --git a/docs/src/gdisp.dox b/docs/src/gdisp.dox deleted file mode 100644 index 0fdeae34..00000000 --- a/docs/src/gdisp.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 GDISP - * @details The GDISP module provides high level abstraction to interface - * pixel oriented graphic displays. - */ - diff --git a/docs/src/ginput.dox b/docs/src/ginput.dox deleted file mode 100644 index 73fbe157..00000000 --- a/docs/src/ginput.dox +++ /dev/null @@ -1,27 +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 GINPUT - * - * @details GINPUT provides an easy and common interface to use different - * input devices such as touchscreens and mices. - */ - diff --git a/docs/src/gtimer.dox b/docs/src/gtimer.dox deleted file mode 100644 index 65dca871..00000000 --- a/docs/src/gtimer.dox +++ /dev/null @@ -1,36 +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 GTIMER - * @details The GTIMER module provides high level, simple and hardware - * independend timers. The timers are meant to be used in different - * ChibiOS/GFX modules and are not very accurate. - * - * @details The reason why ChibiOS/GFX has it's own timer abstraction is because - * virtual timers provided by ChibiOS/RT are interrupt context only. - * While great for what they are designed for, they make coding of the input - * drivers much more complex. - * For non-performance critical drivers like these input drivers, it would also - * hog an in-ordinate amount of critical (interrupt locked) system time. - * This contrary to the goals of a real-time operating system. So a user-land - * (thread based) timer mechanism is also required. - */ - diff --git a/docs/src/gwin.dox b/docs/src/gwin.dox deleted file mode 100644 index 7f5b4115..00000000 --- a/docs/src/gwin.dox +++ /dev/null @@ -1,29 +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 GWIN - * @details The GWIN module does not only provides simple window manager, but also - * different widgets such as a console/terminal, buttons and a module - * to draw graphs. - * @details Please note that GWIN is a module ontop of GDISP. Therefore, GDISP - * has to be set up correctly. - */ - -- cgit v1.2.3