From ba08afef3ec1af2412f526623156f5f50d102ec0 Mon Sep 17 00:00:00 2001 From: Joel Bodenmann Date: Mon, 26 Nov 2012 21:19:32 +0100 Subject: [PATCH] doxygen --- drivers/ginput/toggle/Pal/ginput_lld_toggle.c | 2 +- .../ginput/toggle/Pal/ginput_lld_toggle_board_example.h | 2 +- .../toggle/Pal/ginput_lld_toggle_board_olimexsam7ex256.h | 2 +- drivers/ginput/toggle/Pal/ginput_lld_toggle_config.h | 2 +- drivers/multiple/Win32/gdisp_lld.c | 4 ++-- drivers/multiple/Win32/gdisp_lld_config.h | 8 ++++---- drivers/multiple/Win32/ginput_lld_mouse_config.h | 2 +- include/gdisp/fonts.h | 2 +- include/lld/gdisp/gdisp_lld.h | 2 +- include/lld/gdisp/gdisp_lld_msgs.h | 2 +- include/lld/touchscreen/touchscreen_lld.h | 2 +- src/gtimer.c | 2 ++ 12 files changed, 17 insertions(+), 15 deletions(-) diff --git a/drivers/ginput/toggle/Pal/ginput_lld_toggle.c b/drivers/ginput/toggle/Pal/ginput_lld_toggle.c index 98c2f61b..9da5ca46 100644 --- a/drivers/ginput/toggle/Pal/ginput_lld_toggle.c +++ b/drivers/ginput/toggle/Pal/ginput_lld_toggle.c @@ -19,7 +19,7 @@ */ /** - * @file drivers/ginput/togglePal/ginput_lld_toggle.c + * @file drivers/ginput/toggle/Pal/ginput_lld_toggle.c * @brief GINPUT Toggle low level driver source for the ChibiOS PAL hardware. * * @addtogroup GINPUT_TOGGLE diff --git a/drivers/ginput/toggle/Pal/ginput_lld_toggle_board_example.h b/drivers/ginput/toggle/Pal/ginput_lld_toggle_board_example.h index e8262b9a..3698a81c 100644 --- a/drivers/ginput/toggle/Pal/ginput_lld_toggle_board_example.h +++ b/drivers/ginput/toggle/Pal/ginput_lld_toggle_board_example.h @@ -19,7 +19,7 @@ */ /** - * @file drivers/ginput/togglePal/ginput_lld_toggle_board_example.h + * @file drivers/ginput/toggle/Pal/ginput_lld_toggle_board_example.h * @brief GINPUT Toggle low level driver source for the ChibiOS PAL hardware on the example board. * * @addtogroup GINPUT_TOGGLE diff --git a/drivers/ginput/toggle/Pal/ginput_lld_toggle_board_olimexsam7ex256.h b/drivers/ginput/toggle/Pal/ginput_lld_toggle_board_olimexsam7ex256.h index 3858ad0c..a2b50adf 100644 --- a/drivers/ginput/toggle/Pal/ginput_lld_toggle_board_olimexsam7ex256.h +++ b/drivers/ginput/toggle/Pal/ginput_lld_toggle_board_olimexsam7ex256.h @@ -19,7 +19,7 @@ */ /** - * @file drivers/ginput/togglePal/ginput_lld_toggle_board_olimexsam7ex256.h + * @file drivers/ginput/toggle/Pal/ginput_lld_toggle_board_olimexsam7ex256.h * @brief GINPUT Toggle low level driver source for the ChibiOS PAL hardware on the Olimex SAM7EX256 board. * * @addtogroup GINPUT_TOGGLE diff --git a/drivers/ginput/toggle/Pal/ginput_lld_toggle_config.h b/drivers/ginput/toggle/Pal/ginput_lld_toggle_config.h index f58221f9..3d0d55aa 100644 --- a/drivers/ginput/toggle/Pal/ginput_lld_toggle_config.h +++ b/drivers/ginput/toggle/Pal/ginput_lld_toggle_config.h @@ -19,7 +19,7 @@ */ /** - * @file drivers/ginput/togglePal/ginput_lld_toggle_config.h + * @file drivers/ginput/toggle/Pal/ginput_lld_toggle_config.h * @brief GINPUT Toggle Driver configuration header. * * @addtogroup GDISP diff --git a/drivers/multiple/Win32/gdisp_lld.c b/drivers/multiple/Win32/gdisp_lld.c index 72ad0554..30cd3389 100644 --- a/drivers/multiple/Win32/gdisp_lld.c +++ b/drivers/multiple/Win32/gdisp_lld.c @@ -1,5 +1,5 @@ /* - ChibiOS/RT - Copyright (C) 2012 + ChibiOS/GFX - Copyright (C) 2012 Joel Bodenmann aka Tectu This file is part of ChibiOS/GFX. @@ -19,7 +19,7 @@ */ /** - * @file drivers/gdisp/Win32/gdisp_lld.c + * @file drivers/multiple/Win32/gdisp_lld.c * @brief GDISP Graphics Driver subsystem low level driver source for Win32. * * @addtogroup GDISP diff --git a/drivers/multiple/Win32/gdisp_lld_config.h b/drivers/multiple/Win32/gdisp_lld_config.h index bf018eea..92f5bd4d 100644 --- a/drivers/multiple/Win32/gdisp_lld_config.h +++ b/drivers/multiple/Win32/gdisp_lld_config.h @@ -1,15 +1,15 @@ /* - ChibiOS/RT - Copyright (C) 2012 + ChibiOS/GFX - Copyright (C) 2012 Joel Bodenmann aka Tectu This file is part of ChibiOS-LCD-Driver. - ChibiOS-LCD-Driver is free software; you can redistribute it and/or modify + 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-LCD-Driver is distributed in the hope that it will be useful, + 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. @@ -19,7 +19,7 @@ */ /** - * @file drivers/gdisp/Win32/gdisp_lld_config.h + * @file drivers/multiple/Win32/gdisp_lld_config.h * @brief GDISP Graphic Driver subsystem low level driver header for Win32. * * @addtogroup GDISP diff --git a/drivers/multiple/Win32/ginput_lld_mouse_config.h b/drivers/multiple/Win32/ginput_lld_mouse_config.h index bf063d6d..fc70a4d2 100644 --- a/drivers/multiple/Win32/ginput_lld_mouse_config.h +++ b/drivers/multiple/Win32/ginput_lld_mouse_config.h @@ -18,7 +18,7 @@ along with this program. If not, see . */ /** - * @file drivers/gdisp/Win32/ginput_lld_mouse_config.h + * @file drivers/multiple/Win32/ginput_lld_mouse_config.h * @brief GINPUT LLD header file for mouse/touch driver. * * @addtogroup GINPUT_LLD_MOUSE diff --git a/include/gdisp/fonts.h b/include/gdisp/fonts.h index e3b07e86..e0c7f7de 100644 --- a/include/gdisp/fonts.h +++ b/include/gdisp/fonts.h @@ -19,7 +19,7 @@ */ /** - * @file include/gdisp_fonts.h + * @file include/gdisp/fonts.h * @brief GDISP internal font definitions. * @details This is not generally needed by an application. It is used * by the low level drivers that need to understand a font. diff --git a/include/lld/gdisp/gdisp_lld.h b/include/lld/gdisp/gdisp_lld.h index fecd710a..4e29dc48 100644 --- a/include/lld/gdisp/gdisp_lld.h +++ b/include/lld/gdisp/gdisp_lld.h @@ -19,7 +19,7 @@ */ /** - * @file include/gdisp_lld.h + * @file include/lld/gdisp/gdisp_lld.h * @brief GDISP Graphic Driver subsystem low level driver header. * * @addtogroup GDISP diff --git a/include/lld/gdisp/gdisp_lld_msgs.h b/include/lld/gdisp/gdisp_lld_msgs.h index 5885a70c..f5d29ea1 100644 --- a/include/lld/gdisp/gdisp_lld_msgs.h +++ b/include/lld/gdisp/gdisp_lld_msgs.h @@ -19,7 +19,7 @@ */ /** - * @file include/gdisp_lld_msgs.h + * @file include/lld/gdisp/gdisp_lld_msgs.h * @brief GDISP Graphic Driver subsystem low level driver message structures. * * @addtogroup GDISP diff --git a/include/lld/touchscreen/touchscreen_lld.h b/include/lld/touchscreen/touchscreen_lld.h index 9dd29629..912d2464 100644 --- a/include/lld/touchscreen/touchscreen_lld.h +++ b/include/lld/touchscreen/touchscreen_lld.h @@ -19,7 +19,7 @@ */ /** - * @file include/touchscreen_lld.h + * @file include/lld/touchscreen/touchscreen_lld.h * @brief TOUCHSCREEN Driver subsystem low level driver header. * * @addtogroup TOUCHSCREEN diff --git a/src/gtimer.c b/src/gtimer.c index 8956a190..164822f3 100644 --- a/src/gtimer.c +++ b/src/gtimer.c @@ -258,6 +258,8 @@ void gtimerStop(GTimer *pt) { * * @param[in] pt Pointer to a GTimer structure * + * @return TRUE if active, FALSE otherwise + * * @api */ bool_t gtimerIsActive(GTimer *pt) {