Mirrors_UI_SDK/MiniGUI
1
0
Fork 0
mirror of https://github.com/VincentWei/MiniGUI.git synced 2026-02-05 09:49:57 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

cleanup for doxygen

Browse Source
This commit is contained in:
VincentWei
2018-05-08 03:09:12 +08:00
parent 92fa47663a
commit 990b9eabc9
5 changed files with 2326 additions and 109 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2336
Doxyfile
View File

File diff suppressed because it is too large Load Diff

47
include/gdi.h
View File

@@ -3277,7 +3277,7 @@ MG_EXPORT BOOL GUIAPI FloodFillGenerator (void* context,
#define BITMAP_SCALER_BILINEAR 1
/**
* \fn int GUIAPI SetBitmapScalerType (HDC hdc, int scaler_type);
* \fn int GUIAPI SetBitmapScalerType (HDC hdc, int scaler_type);
*
* \brief set bitmap scaler algorithm callback of DC according by scaler_type.
*
@@ -3292,7 +3292,7 @@ MG_EXPORT BOOL GUIAPI FloodFillGenerator (void* context,
* \sa BitmapDDAScaler, BitmapBinearScaler
*/
MG_EXPORT int GUIAPI SetBitmapScalerType (HDC hdc, int scaler_type);
MG_EXPORT int GUIAPI SetBitmapScalerType (HDC hdc, int scaler_type);
/**
* \fn void GUIAPI MoveTo (HDC hdc, int x, int y)
@@ -4407,8 +4407,7 @@ MG_EXPORT void GUIAPI SelectClipRect (HDC hdc, const RECT* prc);
#define RGN_XOR 0x04
/**
* \fn int GUIAPI SelectClipRegionEx (HDC hdc, const CLIPRGN* pRgn,
int fnMode)
* \fn int GUIAPI SelectClipRegionEx (HDC hdc, const CLIPRGN* pRgn, int fnMode)
* \brief Combines the specified region with the current clipping
* region using the specified mode.
*
@@ -4427,7 +4426,7 @@ MG_EXPORT void GUIAPI SelectClipRect (HDC hdc, const RECT* prc);
* \param hdc Handle to the device context.
* \param pRgn Pointer to the region to be selected. This handle can
* only be NULL when the RGN_COPY mode is specified.
* \param Specifies the operation to be performed. It must be one of
* \param fnMode Specifies the operation to be performed. It must be one of
* the following values:
*
* - RGN_AND\n
@@ -4453,10 +4452,10 @@ MG_EXPORT void GUIAPI SelectClipRect (HDC hdc, const RECT* prc);
* \return The return value specifies the new clipping region's complexity;
* it can be one of the following values.
*
* \retvalue NULLREGION Region is empty.
* \retvalue SIMPLEREGION Region is a single rectangle.
* \retvalue COMPLEXREGION Region is more than one rectangle.
* \retvalue -1 An error occurred.
* \retval NULLREGION Region is empty.
* \retval SIMPLEREGION Region is a single rectangle.
* \retval COMPLEXREGION Region is more than one rectangle.
* \retval -1 An error occurred.
*
* \sa SelectClipRect, SelectClipRegion, GetClipRegion, region_fns
*/
@@ -4492,10 +4491,10 @@ MG_EXPORT void GUIAPI SelectClipRegion (HDC hdc, const CLIPRGN* pRgn);
* \return The return value specifies the new clipping region's complexity;
* it can be one of the following values.
*
* \retvalue NULLREGION Region is empty.
* \retvalue SIMPLEREGION Region is a single rectangle.
* \retvalue COMPLEXREGION Region is more than one rectangle.
* \retvalue -1 An error occurred.
* \retval NULLREGION Region is empty.
* \retval SIMPLEREGION Region is a single rectangle.
* \retval COMPLEXREGION Region is more than one rectangle.
* \retval -1 An error occurred.
*
* \sa SelectClipRegion
*/
@@ -4555,7 +4554,7 @@ MG_EXPORT BOOL GUIAPI RectVisible (HDC hdc, const RECT* pRect);
MG_EXPORT int GUIAPI GetClipBox (HDC hdc, RECT* clipbox);
/**
* \fn int GetClipRgn (HDC hdc, CLIPRGN* cliprgn)
* \fn int GetClipRegion (HDC hdc, CLIPRGN* cliprgn)
* \brief Gets the current clipping region of a DC.
*
* This function gets the current clipping region
@@ -7675,6 +7674,26 @@ MG_EXPORT int GUIAPI LoadBitmapFromMem (HDC hdc, PBITMAP pBitmap,
*/
MG_EXPORT void GUIAPI UnloadBitmap (PBITMAP pBitmap);
/**
* \fn int GUIAPI SetBitmapKeyColor (HDC hdc, PBITMAP bmp,
* Uint8 r, Uint8 g, Uint8 b)
* \brief Set the bitmap color key.
*
* This function set the bitmap member bmColorKey with the param r,g,b and
* set the BMP_TYPE_COLORKEY flag.
*
* \param hdc The device context.
* \param bmp Point of the bitmap which to set color key.
* \param r The red componets of RGB color.
* \param g The green componets of RGB color.
* \param b The blue componets of RGB color.
*
* \return ERR_BMP_OK for success, ERR_BMP_UNKNOWN_TYPE for error.
*
* /sa SetMemDCColorKey
*/
MG_EXPORT int GUIAPI SetBitmapKeyColor (HDC hdc, PBITMAP bmp, Uint8 r, Uint8 g, Uint8 b);
/**
* \fn void GUIAPI ReplaceBitmapColor (HDC hdc, PBITMAP pBitmap, \
gal_pixel iOColor, gal_pixel iNColor)

43
include/window.h
View File

@@ -3243,7 +3243,7 @@ MG_EXPORT HWND GUIAPI RegisterMouseHookWindow (HWND hwnd, DWORD flag);
* \def WS_EX_AUTOSECONDARYDC
* \brief The window creates its own secondary device context automatically.
*
* \sa CreateSencondaryDC
* \sa CreateSecondaryDC
*/
#define WS_EX_AUTOSECONDARYDC 0x00001000L
@@ -4334,8 +4334,7 @@ MG_EXPORT gal_pixel GUIAPI GetWindowElementPixelEx (HWND hwnd,
HDC hdc, int we_attr_id);
/**
* \fn WINDOW_ELEMENT_RENDERER*
GUIAPI GetWindowRendererFromName (const char* name)
* \fn WINDOW_ELEMENT_RENDERER* GUIAPI GetWindowRendererFromName (const char* name)
* \brief Get window renderer from name.
*
* \param name The renderer name.
@@ -4343,7 +4342,7 @@ MG_EXPORT gal_pixel GUIAPI GetWindowElementPixelEx (HWND hwnd,
* This function gets window renderer from the specified name \a name,
* which is case-insensitive.
*
* \return The handle to the window renderer for success, NULL for failure.
* \return The pointer to the window renderer for success, NULL for failure.
*
* \note The prototype had changed since MiniGUI v3.2; the old one returns
* a const value.
@@ -5298,6 +5297,8 @@ extern MG_EXPORT WNDPROC __mg_def_proc[3];
MG_EXPORT void GUIAPI DumpWindow (FILE* fp, HWND hWnd);
#endif /* _DEBUG */
/** @} end of window_create_fns */
/**
* \defgroup window_general_fns General window operations
* @{
@@ -5820,7 +5821,7 @@ MG_EXPORT BOOL GUIAPI InvalidateRect (HWND hWnd,
* The region is assumed to have client coordinates. If this
* parameter is NULL, the entire client area is added to the
* update region.
* \param bEraseBkgnd Specifies whether the background within the
* \param bErase Specifies whether the background within the
* update region should be erased when the update region is processed.
* If this parameter is TRUE, the background is erased. If the
* parameter is FALSE, the background remains unchanged.
@@ -5959,10 +5960,10 @@ MG_EXPORT BOOL GUIAPI GetUpdateRect (HWND hWnd, RECT* update_rect);
* of the window.
*
* \return The region type.
* \retvalue NULLREGION Region is empty.
* \retvalue SIMPLEREGION Region is a single rectangle.
* \retvalue COMPLEXREGION Region is more than one rectangle.
* \retvalue -1 An error occurred.
* \retval NULLREGION Region is empty.
* \retval SIMPLEREGION Region is a single rectangle.
* \retval COMPLEXREGION Region is more than one rectangle.
* \retval -1 An error occurred.
*
* \sa GetUpdateRect
*/
@@ -9889,30 +9890,10 @@ MG_EXPORT int GUIAPI MessageBox (HWND hParentWnd, const char* pszText,
*/
MG_EXPORT void GUIAPI MessageBeep (DWORD dwBeep);
/**
* \fn int GUIAPI SetBitmapKeyColor (HDC hdc, PBITMAP bmp,
* Uint8 r, Uint8 g, Uint8 b)
* \brief Set the bitmap color key.
*
* This function set the bitmap member bmColorKey with the param r,g,b and
* set the BMP_TYPE_COLORKEY flag.
*
* \param hdc The device context.
* \param bmp Point of the bitmap which to set color key.
* \param r The red componets of RGB color.
* \param g The green componets of RGB color.
* \param b The blue componets of RGB color.
*
* \return ERR_BMP_OK for success, ERR_BMP_UNKNOWN_TYPE for error.
*
* /sa SetMemDCColorKey
*/
MG_EXPORT int GUIAPI SetBitmapKeyColor (HDC hdc, PBITMAP bmp, Uint8 r, Uint8 g, Uint8 b);
/** @} end of dialog_fns */
/** @} end of msgbox_fns */
/** @} end of window_fns */
/** @} end of fns */
#ifdef __cplusplus
}
#endif /* __cplusplus */

2
include/xvfb.h
View File

@@ -242,7 +242,7 @@ MG_EXPORT XVFBHeader* GUIAPI xVFBAllocVirtualFrameBuffer (int width, int height,
MG_EXPORT void GUIAPI xVFBFreeVirtualFrameBuffer (XVFBHeader* buf);
/**
* \fn int xVFBNotifyNewEvent (const void* xvfb_event_buffer, XVFBEVENT* event)
* \fn void* GUIAPI xVFBCreateEventBuffer (int nr_events)
* \brief create event circular buffer.
* \param nr_events capability of the event buffer
* \return the address of event circular buffer.

7
make_tarball
View File

@@ -1,12 +1,13 @@
#!/bin/bash
SOURCE_DIR=libminigui-3.0.13
DEST_DIR=libminigui-3.0.13
VERSION=3.2.0
SOURCE_DIR=libminigui-$VERSION
DEST_DIR=libminigui-$VERSION
. .config
if [ "$PACK_OS_LINUX" = "n" ]; then
DEST_DIR=libminigui-3.0.13
DEST_DIR=libminigui-$VERSION
fi
[ -f ".config" ] || {