some more doxygen fixes

ugfx_release_2.6
Joel Bodenmann 2014-09-28 23:42:53 +02:00
parent 8d7bbe7e45
commit 0253b7df49
4 changed files with 42 additions and 23 deletions

View File

@ -250,6 +250,8 @@ unsigned gdispGetDisplayCount(void);
*
* @param[in] g The display to use
*
* @return The width of the display
*
* @api
*/
coord_t gdispGGetWidth(GDisplay *g);
@ -260,6 +262,8 @@ coord_t gdispGGetWidth(GDisplay *g);
*
* @param[in] g The display to use
*
* @return The height of the display
*
* @api
*/
coord_t gdispGGetHeight(GDisplay *g);
@ -270,6 +274,8 @@ coord_t gdispGGetHeight(GDisplay *g);
*
* @param[in] g The display to use
*
* @return The current power mode
*
* @api
*/
powermode_t gdispGGetPowerMode(GDisplay *g);
@ -280,6 +286,8 @@ powermode_t gdispGGetPowerMode(GDisplay *g);
*
* @param[in] g The display to use
*
* @return The current orientation
*
* @api
*/
orientation_t gdispGGetOrientation(GDisplay *g);
@ -290,6 +298,8 @@ orientation_t gdispGGetOrientation(GDisplay *g);
*
* @param[in] g The display to use
*
* @return The current backlight value
*
* @api
*/
uint8_t gdispGGetBacklight(GDisplay *g);
@ -300,6 +310,8 @@ uint8_t gdispGGetBacklight(GDisplay *g);
*
* @param[in] g The display to use
*
* @return The current contrast value
*
* @api
*/
uint8_t gdispGGetContrast(GDisplay *g);

View File

@ -103,21 +103,21 @@ extern "C" {
* @return Valid GFILE on success, 0 otherwise
*
* @note The modes follow the c library fopen() standard.
* The valid modes are:<br/>
* The valid modes are:
* <ul><li>r - Open for read, the file must exist</li>
* <li>w - Open for write, the file is truncated if it exists</li>
* <li>wx - Open for write, the file must not exist</li>
* <li>a - Open for append, the file is truncated if it exists</li>
* <li>ax - Open for append, the file must not exists</li>
* </ul><br/>
* THe following flags can also be added to the above modes:<br/>
* </ul>
* The following flags can also be added to the above modes:<br/>
* <ul><li>+ - Open for both read and write</li>
* <li>b - Open as a binary file rather than a text file</li>
* <ul>
* </ul>
* @note Not all file-systems support all modes. For example, write
* is not available with the ROM file-system. Similarly few platforms
* distinguish between binary and text files.
* @note Even though binary vs text is relevant only for a small number of platforms
* @note Even though binary vs. text is relevant only for a small number of platforms
* the "b" flag should always be specified for binary files such as images.
* This ensures portability to other platforms. The extra flag will be ignored
* on platforms where it is not relevant.
@ -346,8 +346,8 @@ extern "C" {
/**
* @brief Open file from a null terminated C string
*
* @param[in] memptr The pointer to the string or string buffer
* @param[in] mode The mode.
* @param[in] str The pointer to the string or string buffer
* @param[in] mode The mode
*
* @return Valid GFILE on success, 0 otherwise
*

View File

@ -17,7 +17,7 @@
#ifndef _LLD_GINPUT_MOUSE_H
#define _LLD_GINPUT_MOUSE_H
#if GINPUT_NEED_MOUSE || defined(__DOXYGEN__)
#if GINPUT_NEED_MOUSE //|| defined(__DOXYGEN__)
// Include the GDRIVER infrastructure
#include "src/gdriver/sys_defs.h"
@ -108,19 +108,36 @@ typedef struct GMouseVMT {
extern "C" {
#endif
/**
* @brief Routines needed by the general driver VMT
* @note These routines are provided by the high level code for
* use in the GMouseVMT.d structure.
* @brief Initialize a mouse driver
*
* @param[in] g The mouse driver
* @param[in] display The display to which the mouse shall be assigned
* @param[in] driverinstance The driver instance ToDo: Add some more details
* @param[in] systeminstance The mouse instance ToDo: Add some more details
*
* @return TRUE on success, FALSE otherwise
*
* @notapi
* @{
*/
bool_t _gmouseInitDriver(GDriver *g, void *display, unsigned driverinstance, unsigned systeminstance);
/**
* @brief Routine that is called after initialization
*
* @param[in] g The mouse driver
*
* @notapi
*/
void _gmousePostInitDriver(GDriver *g);
/**
* @brief Deinitialize a mouse driver
*
* @param[in] g The mouse driver
*
* @notapi
*/
void _gmouseDeInitDriver(GDriver *g);
/** @} */
/**
* @brief Wakeup the high level code so that it attempts another read

View File

@ -305,16 +305,6 @@ void gwinSetCustomDraw(GHandle gh, CustomWidgetDrawFunction fn, void *param);
bool_t gwinAttachListener(GListener *pl);
#if (GFX_USE_GINPUT && GINPUT_NEED_MOUSE) || defined(__DOXYGEN__)
/**
* @brief Set the mouse to be used to control the widgets
* @return TRUE on success
*
* @param[in] instance The mouse instance
*
* @note Every widget uses the same mouse.
*
* @api
*/
bool_t DEPRECATED("This call can now be removed. Attaching the mouse to GWIN is now automatic.") gwinAttachMouse(uint16_t instance);
#endif