Browse Source

doxygen updates

remotes/origin_old/ugfx_release_2.6
Joel Bodenmann 10 years ago
parent
commit
a675834266
  1. 4
      Doxygenfile
  2. 38
      docs/src/main.dox
  3. 4
      drivers/gdisp/RA8875/gdisp_lld_board_marlin.h
  4. 2
      drivers/gdisp/SSD1289/gdisp_lld_board_st_stm32f4_discovery.h
  5. 2
      drivers/ginput/touch/FT5x06/ginput_lld_mouse_board_marlin.h
  6. 3
      include/gadc/gadc.h
  7. 3
      include/gaudin/gaudin.h
  8. 3
      include/gaudout/gaudout.h
  9. 2
      include/gdisp/gdisp.h
  10. 3
      include/gevent/gevent.h
  11. 3
      include/gfx.h
  12. 3
      include/ginput/ginput.h
  13. 4
      include/gmisc/gmisc.h
  14. 6
      include/gos/gos.h
  15. 7
      include/gqueue/gqueue.h
  16. 3
      include/gtimer/gtimer.h
  17. 4
      include/gwin/class_gwin.h
  18. 1
      include/gwin/gwin.h
  19. 2
      include/gwin/options.h
  20. 2
      include/tdisp/tdisp.h
  21. 1
      src/gwin/list.c

4
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

38
docs/src/main.dox

@ -1,35 +1,23 @@
/*
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/>.
*/
/*
* 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:
*
* http://ugfx.com/license.html
*/
/**
* @mainpage ChibiOS/GFX
* @mainpage uGFX
* @author Joel Bodenmann (joel@unormal.org).
*
* <h2>ChibiOS/GFX</h2>
* ChibiOS/GFX is an official add-on library for ChibiOS/RT to
* interface all different types of LCDs and touchscreens.
* <h2>uGFX</h2>
* µ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.
*
* <h2>Documentation</h2>
* - http://chibios-gfx.com
* - http://ugfx.org
*
* <h2>License</h2>
* - http://chibios-gfx.com/license.html
* - http://ugfx.org/license.html
*/

4
drivers/gdisp/RA8875/gdisp_lld_board.h → 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
* @{

2
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

2
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

3
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

3
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)
*
* @{
*/

3
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)
*
* @{
*/

2
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

3
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.
*

3
include/gfx.h

@ -10,6 +10,9 @@
* @brief GFX system header file.
*
* @addtogroup GFX
*
* @brief Main module to glue all the others together
*
* @{
*/

3
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.
*

4
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
*
* @{
*/

6
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.
* @{

7
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:
* <ul><li><b>Asynchronous Queues (ASync) </b> - Queue operations never block</li>
* <li><b>Get Synchronous Queues (GSync) </b> - Queue Get operations block until something is placed in the Queue</li>
* <li><b>Put Synchronous Queues (PSync)</b> - Queue Put operations block until the element is removed from the Queue</li>
@ -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
* @{

3
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

4
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);

1
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

2
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
*
* @{
*/

2
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.
*

1
src/gwin/list.c

@ -70,4 +70,5 @@ GHandle gwinListCreate(GListObject* widget, GWidgetInit* pInit) {
}
#endif // GFX_USE_GWIN && GWIN_NEED_LIST
/** @} */

Loading…
Cancel
Save