From a6758342668712563bd4058160e6f5dc5636ba18 Mon Sep 17 00:00:00 2001 From: Joel Bodenmann Date: Sun, 21 Jul 2013 22:02:57 +0200 Subject: [PATCH] doxygen updates --- Doxygenfile | 4 +- docs/src/main.dox | 52 +++++++------------ ...p_lld_board.h => gdisp_lld_board_marlin.h} | 4 +- .../gdisp_lld_board_st_stm32f4_discovery.h | 2 +- .../FT5x06/ginput_lld_mouse_board_marlin.h | 2 +- include/gadc/gadc.h | 3 +- include/gaudin/gaudin.h | 3 +- include/gaudout/gaudout.h | 3 +- include/gdisp/gdisp.h | 2 + include/gevent/gevent.h | 3 +- include/gfx.h | 3 ++ include/ginput/ginput.h | 3 +- include/gmisc/gmisc.h | 4 +- include/gos/gos.h | 6 ++- include/gqueue/gqueue.h | 7 ++- include/gtimer/gtimer.h | 3 +- include/gwin/class_gwin.h | 4 ++ include/gwin/gwin.h | 1 - include/gwin/options.h | 2 + include/tdisp/tdisp.h | 2 + src/gwin/list.c | 1 + 21 files changed, 64 insertions(+), 50 deletions(-) rename drivers/gdisp/RA8875/{gdisp_lld_board.h => gdisp_lld_board_marlin.h} (98%) diff --git a/Doxygenfile b/Doxygenfile index 15368ddd..770d7d5a 100644 --- a/Doxygenfile +++ b/Doxygenfile @@ -28,13 +28,13 @@ DOXYFILE_ENCODING = UTF-8 # identify the project. Note that if you do not use Doxywizard you need # to put quotes around the project name if it contains spaces. -PROJECT_NAME = ChibiOS/GFX +PROJECT_NAME = uGFX # The PROJECT_NUMBER tag can be used to enter a project or revision number. # This could be handy for archiving the generated documentation or # if some version control system is used. -PROJECT_NUMBER = 1.6 +PROJECT_NUMBER = 1.7 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer diff --git a/docs/src/main.dox b/docs/src/main.dox index 89c8006a..2de3df90 100644 --- a/docs/src/main.dox +++ b/docs/src/main.dox @@ -1,35 +1,23 @@ -/* - 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). +/* + * This file is subject to the terms of the GFX License. If a copy of + * the license was not distributed with this file, you can obtain one at: * - *

ChibiOS/GFX

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

Documentation

- * - http://chibios-gfx.com - * - *

License

- * - http://chibios-gfx.com/license.html + * http://ugfx.com/license.html + */ + +/** + * @mainpage uGFX + * @author Joel Bodenmann (joel@unormal.org). + * + *

uGFX

+ * µGFX is a library to interface different displays and touchscreen + * to your embedded application. Extreme low system requirements are our + * goal. A complete GUI toolkit is provided. + * + *

Documentation

+ * - http://ugfx.org + * + *

License

+ * - http://ugfx.org/license.html */ diff --git a/drivers/gdisp/RA8875/gdisp_lld_board.h b/drivers/gdisp/RA8875/gdisp_lld_board_marlin.h similarity index 98% rename from drivers/gdisp/RA8875/gdisp_lld_board.h rename to drivers/gdisp/RA8875/gdisp_lld_board_marlin.h index d0ab5409..a58b991a 100644 --- a/drivers/gdisp/RA8875/gdisp_lld_board.h +++ b/drivers/gdisp/RA8875/gdisp_lld_board_marlin.h @@ -6,8 +6,8 @@ */ /** - * @file drivers/gdisp/SSD1289/gdisp_lld_board_example_fsmc.h - * @brief GDISP Graphic Driver subsystem board interface for the SSD1289 display. + * @file drivers/gdisp/RA8875/gdisp_lld_board_marlin.h + * @brief GDISP Graphic Driver subsystem board interface for the RA8875 display. * * @addtogroup GDISP * @{ diff --git a/drivers/gdisp/SSD1289/gdisp_lld_board_st_stm32f4_discovery.h b/drivers/gdisp/SSD1289/gdisp_lld_board_st_stm32f4_discovery.h index 72fcc710..d2ee1e35 100644 --- a/drivers/gdisp/SSD1289/gdisp_lld_board_st_stm32f4_discovery.h +++ b/drivers/gdisp/SSD1289/gdisp_lld_board_st_stm32f4_discovery.h @@ -6,7 +6,7 @@ */ /** - * @file drivers/gdisp/SSD1289/gdisp_lld_board_example_fsmc.h + * @file drivers/gdisp/SSD1289/gdisp_lld_board_st_stm32f4_discovery.h * @brief GDISP Graphic Driver subsystem board interface for the SSD1289 display. * * @addtogroup GDISP diff --git a/drivers/ginput/touch/FT5x06/ginput_lld_mouse_board_marlin.h b/drivers/ginput/touch/FT5x06/ginput_lld_mouse_board_marlin.h index 06b408dd..e57df1d0 100644 --- a/drivers/ginput/touch/FT5x06/ginput_lld_mouse_board_marlin.h +++ b/drivers/ginput/touch/FT5x06/ginput_lld_mouse_board_marlin.h @@ -6,7 +6,7 @@ */ /** - * @file drivers/ginput/touch/FT5x06/ginput_lld_mouse_board.h + * @file drivers/ginput/touch/FT5x06/ginput_lld_mouse_board_marlin.h * @brief GINPUT Touch low level driver source for the FT5x06. * * @defgroup Mouse Mouse diff --git a/include/gadc/gadc.h b/include/gadc/gadc.h index ce2ad658..f3595f99 100644 --- a/include/gadc/gadc.h +++ b/include/gadc/gadc.h @@ -7,10 +7,11 @@ /** * @file include/gadc/gadc.h - * @brief GADC - Periodic ADC subsystem header file. * * @addtogroup GADC * + * @brief Module to abstract the very variable ADC interfaces of the underlying systems + * * @details The reason why ChibiOS/GFX has it's own ADC abstraction is because * the Chibi-OS drivers are very CPU specific and do not * provide a way across all hardware platforms to create periodic diff --git a/include/gaudin/gaudin.h b/include/gaudin/gaudin.h index 3e6f9fe3..f50499a6 100644 --- a/include/gaudin/gaudin.h +++ b/include/gaudin/gaudin.h @@ -7,10 +7,11 @@ /** * @file include/gaudin/gaudin.h - * @brief GAUDIN - Audio Input subsystem header file. * * @addtogroup GAUDIN * + * @brief Module to read audio inputs (under development) + * * @{ */ diff --git a/include/gaudout/gaudout.h b/include/gaudout/gaudout.h index 7d096ba7..ab46e9c5 100644 --- a/include/gaudout/gaudout.h +++ b/include/gaudout/gaudout.h @@ -7,10 +7,11 @@ /** * @file include/gaudout/gaudout.h - * @brief GAUDOUT - Audio Output subsystem header file. * * @addtogroup GAUDOUT * + * @brief Module to output audio data (under development) + * * @{ */ diff --git a/include/gdisp/gdisp.h b/include/gdisp/gdisp.h index 2497801a..931a87cd 100644 --- a/include/gdisp/gdisp.h +++ b/include/gdisp/gdisp.h @@ -11,6 +11,8 @@ * * @addtogroup GDISP * + * @brief Module to interface graphic / pixel oriented displays + * * @details The GDISP module provides high level abstraction to interface pixel oriented graphic displays. * * @pre GFX_USE_GDISP must be set to TRUE in gfxconf.h diff --git a/include/gevent/gevent.h b/include/gevent/gevent.h index 5868f70f..7fb3c7ca 100644 --- a/include/gevent/gevent.h +++ b/include/gevent/gevent.h @@ -7,10 +7,11 @@ /** * @file include/gevent/gevent.h - * @brief GEVENT GFX User Event subsystem header file. * * @addtogroup GEVENT * + * @brief Module to build a complete many-to-many event system + * * @details GEVENT provides a simple to use but yet powerful event * system. * diff --git a/include/gfx.h b/include/gfx.h index 24cc4ac4..951149ad 100644 --- a/include/gfx.h +++ b/include/gfx.h @@ -10,6 +10,9 @@ * @brief GFX system header file. * * @addtogroup GFX + * + * @brief Main module to glue all the others together + * * @{ */ diff --git a/include/ginput/ginput.h b/include/ginput/ginput.h index 610ec45b..a372cc6f 100644 --- a/include/ginput/ginput.h +++ b/include/ginput/ginput.h @@ -7,10 +7,11 @@ /** * @file include/ginput/ginput.h - * @brief GINPUT GFX User Input subsystem header file. * * @addtogroup GINPUT * + * @brief Module to interface different hardware input sources such as touchscreens + * * @details GINPUT provides an easy and common interface to use different input devices * such as touchscreens and mices. * diff --git a/include/gmisc/gmisc.h b/include/gmisc/gmisc.h index 4bebc984..382fc867 100644 --- a/include/gmisc/gmisc.h +++ b/include/gmisc/gmisc.h @@ -9,7 +9,9 @@ * @file include/gmisc/gmisc.h * @brief GMISC - Miscellaneous Routines header file. * - * @addtogroup GAUDIN + * @addtogroup GMISC + * + * @brief Module which contains different features such as array conversions * * @{ */ diff --git a/include/gos/gos.h b/include/gos/gos.h index 54bde39a..e3d524d7 100644 --- a/include/gos/gos.h +++ b/include/gos/gos.h @@ -7,10 +7,12 @@ /** * @file include/gos/gos.h - * @brief GOS - Operating System Support header file. + * @brief GOS - Operating System Support header file * * @addtogroup GOS - * @brief GOS provides the operating system interface with the GFX library. + * + * @brief Module to build a uniform abstraction layer between uGFX and the underlying system + * * @note Some of the routines specified below may be implemented simply as * a macro to the real operating system call. * @{ diff --git a/include/gqueue/gqueue.h b/include/gqueue/gqueue.h index 8ec3c9b9..68cfdc2f 100644 --- a/include/gqueue/gqueue.h +++ b/include/gqueue/gqueue.h @@ -10,7 +10,10 @@ * @brief GQUEUE header file. * * @addtogroup GQUEUE - * @brief GQUEUE provides queue management. There are 3 types of queues: + * + * @brief Module which provides queue management (only internally used) + * + * @details There are 3 types of queues: *
  • Asynchronous Queues (ASync) - Queue operations never block
    • *
  • Get Synchronous Queues (GSync) - Queue Get operations block until something is placed in the Queue
    • *
  • Put Synchronous Queues (PSync) - Queue Put operations block until the element is removed from the Queue
    • @@ -128,7 +131,7 @@ bool_t gfxQueueFSyncPut(gfxQueueFSync *pqueue, gfxQueueFSyncItem *pitem, delayti /** * @brief Pop an item from the head of the queue (and remove it from the queue). - * @detail This is exactly the same as the Get operation above. + * @details This is exactly the same as the Get operation above. * * @api * @{ diff --git a/include/gtimer/gtimer.h b/include/gtimer/gtimer.h index 494cc201..2b3991ec 100644 --- a/include/gtimer/gtimer.h +++ b/include/gtimer/gtimer.h @@ -7,10 +7,11 @@ /** * @file include/gtimer/gtimer.h - * @brief GTIMER GFX User Timer subsystem header file. * * @addtogroup GTIMER * + * @brief Module which provides software based timers for user-space applications + * * @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 diff --git a/include/gwin/class_gwin.h b/include/gwin/class_gwin.h index 3be496b1..02ffdf52 100644 --- a/include/gwin/class_gwin.h +++ b/include/gwin/class_gwin.h @@ -155,6 +155,8 @@ extern "C" { * @param[in] vmt The virtual method table for the GWIN object * @param[in] flags The default flags to use * + * @return The GHandle of the created window + * * @notapi */ GHandle _gwindowCreate(GWindowObject *pgw, const GWindowInit *pInit, const gwinVMT *vmt, uint16_t flags); @@ -167,6 +169,8 @@ GHandle _gwindowCreate(GWindowObject *pgw, const GWindowInit *pInit, const gwinV * @param[in] pInit The user initialization parameters * @param[in] vmt The virtual method table for the Widget object * + * @return The GHandle of the created widget + * * @notapi */ GHandle _gwidgetCreate(GWidgetObject *pgw, const GWidgetInit *pInit, const gwidgetVMT *vmt); diff --git a/include/gwin/gwin.h b/include/gwin/gwin.h index 53f5e205..e09fd2e8 100644 --- a/include/gwin/gwin.h +++ b/include/gwin/gwin.h @@ -7,7 +7,6 @@ /** * @file include/gwin/gwin.h - * @brief GWIN Graphic window subsystem header file. * * @defgroup Window Window * @ingroup GWIN diff --git a/include/gwin/options.h b/include/gwin/options.h index 5a90dacd..be46c3ee 100644 --- a/include/gwin/options.h +++ b/include/gwin/options.h @@ -10,6 +10,8 @@ * @brief GWIN sub-system options header file. * * @addtogroup GWIN + * @brief Module which provides a complete GUI toolkit based on widgets + * * @{ */ diff --git a/include/tdisp/tdisp.h b/include/tdisp/tdisp.h index c05d574f..9f264b25 100644 --- a/include/tdisp/tdisp.h +++ b/include/tdisp/tdisp.h @@ -11,6 +11,8 @@ * * @addtogroup TDISP * + * @brief Module to drive character / dot matrix based displays + * * @details The TDISP module provides high level abstraction to interface pixel oriented graphic displays. * Due the TDISP module is completely encapsulated from the other modules, it's very fast and lightweight. * diff --git a/src/gwin/list.c b/src/gwin/list.c index 475b4fba..ea0505dc 100644 --- a/src/gwin/list.c +++ b/src/gwin/list.c @@ -70,4 +70,5 @@ GHandle gwinListCreate(GListObject* widget, GWidgetInit* pInit) { } #endif // GFX_USE_GWIN && GWIN_NEED_LIST +/** @} */