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

add change description for Doxygen

Browse Source
This commit is contained in:
VincentWei
2018-01-31 18:56:23 +08:00
parent 242423951d
commit 4a29921154
3 changed files with 33 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
include/ctrl/ctrlhelper.h
View File

@@ -195,7 +195,7 @@ MG_EXPORT void DestroyToolTipWin (HWND hwnd);
* \param code The notification code.
* \param add_data The additional data of the notification.
*
* \note TODO
* \note The type of \a id change from int to LINT since v3.2.
*
* \sa SetNotificationCallback
*/

1
include/ctrl/gridview.h
View File

@@ -624,7 +624,6 @@ typedef struct _GRIDCELLDATA
*/
#define GRIDM_DELDEPENDENCE 0xF220
/*TODO messages for query dependence */
/**
* \def GRIDM_ENDCELLEDIT
* \brief This message is used inside minigui.

56
include/window.h
View File

@@ -1629,7 +1629,13 @@ typedef struct _DRAGINFO {
* \param code The notification code.
* \param hwnd The handle to the control.
*
* \note TODO
* \note If you use `MSG_COMMAND` message to handle the notification
* sent from children controls, you should make sure the identifier
* value is small enough on 64-bit platform. If you use a pointer
* as the the identifier of a control, the code above will not work.
*
* Instead, we recommend strongly that you use a NOTIFYPOROC
* callback to handle the notification generated by controls.
*
* \sa NotifyParentEx
*/
@@ -4118,7 +4124,7 @@ typedef struct _WINDOWINFO
/** The caption of window.*/
char* spCaption;
/** The identifier of window.
* TODO
* \note The type changed from int to LINT since v3.2.
*/
LINT id;
@@ -7508,7 +7514,7 @@ MG_EXPORT BOOL GUIAPI DestroyWindow (HWND hWnd);
* when a notification occurred the control will call this callback
* procedure.
*
* \note TODO
* \note The type of \a id changed from int to LINT since v3.2.
*
* \sa SetNotificationCallback
*/
@@ -8466,7 +8472,7 @@ typedef struct _MENUITEMINFO {
UINT state;
/** The identifier of the menu item.
* \note TODO
* \note The type changed from int to LINT since v3.2.
*/
LINT id;
@@ -8562,7 +8568,7 @@ MG_EXPORT HMENU GUIAPI CreateSystemMenu (HWND hwnd, DWORD dwStyle);
* \retval ERR_RES_ALLOCATION Can not allocate new menu item.
* \retval ERR_INVALID_HMENU \a hmnu is an invalid menu.
*
* \note TODO
* \note The type of \a item changed from int to LINT since v3.2.
*
* \sa RemoveMenu, MENUITEMINFO
*/
@@ -8591,7 +8597,7 @@ MG_EXPORT int GUIAPI InsertMenuItem (HMENU hmnu, LINT item,
* \retval ERR_INVALID_HANDLE \a hmnu is not a handle to menu.
* \retval ERR_INVALID_HMENU \a hmnu is an invalid menu.
*
* \note TODO
* \note The type of \a item changed from int to LINT since v3.2.
*
* \sa InsertMenuItem, DeleteMenu
*/
@@ -8618,7 +8624,7 @@ MG_EXPORT int GUIAPI RemoveMenu (HMENU hmnu, LINT item, UINT flag);
* \retval ERR_INVALID_HANDLE \a hmnu is not a handle to menu.
* \retval ERR_INVALID_HMENU \a hmnu is an invalid menu.
*
* \note TODO
* \note The type of \a item changed from int to LINT since v3.2.
*
* \sa InsertMenuItem, RemoveMenu
*/
@@ -8857,7 +8863,7 @@ MG_EXPORT int GUIAPI GetMenuItemID (HMENU hmnu, int pos);
*
* \return The function returns 0 for success, non-zero for failure.
*
* \note TODO
* \note The type of \a item changed from int to LINT since v3.2.
*
* \sa SetMenuItemInfo, MENUITEMINFO
*/
@@ -8951,7 +8957,7 @@ MG_EXPORT HMENU GUIAPI GetSystemMenu (HWND hwnd, BOOL flag);
* \return The return value specifies the previous state of the menu item.
* If the menu item does not exist, the return value is -1.
*
* \note TODO
* \note The type of \a item changed from int to LINT since v3.2.
*
* \sa GetMenuItemInfo
*/
@@ -8978,7 +8984,8 @@ MG_EXPORT UINT GUIAPI EnableMenuItem (HMENU hmnu, LINT item, UINT flag);
*
* \return The function returns 0 for success, non-zero for failure.
*
* \note TODO
* \note The type of \a first, \a last, \a checkitem changed from
* int to LINT since v3.2.
*
* \sa SetMenuItemInfo, MENUITEMINFO
*/
@@ -9006,7 +9013,7 @@ MG_EXPORT int GUIAPI CheckMenuRadioItem (HMENU hmnu, LINT first, LINT last,
*
* \return The function returns 0 for success, non-zero for failure.
*
* \note TODO
* \note The type of \a item changed from int to LINT since v3.2.
*
* \sa SetMenuItemInfo, MENUITEMINFO
*/
@@ -9032,7 +9039,7 @@ MG_EXPORT int GUIAPI SetMenuItemBitmaps (HMENU hmnu, LINT item, UINT flag,
*
* \return The function returns 0 for success, non-zero for failure.
*
* \note TODO
* \note The type of \a item changed from int to LINT since v3.2.
*
* \sa GetMenuItemInfo, MENUITEMINFO
*/
@@ -9122,7 +9129,7 @@ typedef struct _CTRLDATA
/** Control position in dialog */
int x, y, w, h;
/** Control identifier
* \note TODO
* \note The type changed from int to LINT since v3.2.
*/
LINT id;
/** Control caption */
@@ -9366,7 +9373,7 @@ MG_EXPORT HWND GUIAPI GetDlgDefPushButton (HWND hWnd);
*
* \return The identifier of the control, -1 for error.
*
* \note TODO
* \note The type of return value changed from int to LINT since v3.2.
*
* \sa GetDlgItem
*/
@@ -9382,7 +9389,7 @@ MG_EXPORT LINT GUIAPI GetDlgCtrlID (HWND hwndCtl);
* \param hDlg The handle to the dialog box.
* \param nIDDlgItem The identifier of the control.
*
* \note TODO
* \note The type of \a nIDDlgItem changed from int to LINT since v3.2.
*
* \return The handle to the control, zero for not found.
*/
@@ -9416,7 +9423,7 @@ MG_EXPORT HWND GUIAPI GetDlgItem (HWND hDlg, LINT nIDDlgItem);
* - [+|-][1-9][0-9]*\n
* Will be read in base 10.
*
* \note TODO
* \note The type of \a nIDDlgItem changed from int to LINT since v3.2.
*
* \sa GetDlgItemText, SetDlgItemInt
*/
@@ -9441,7 +9448,7 @@ MG_EXPORT UINT GUIAPI GetDlgItemInt (HWND hDlg, LINT nIDDlgItem,
*
* \note The buffer should at least have size of (\a nMaxCount + 1).
*
* \note TODO
* \note The type of \a nIDDlgItem changed from int to LINT since v3.2.
*
* \sa GetDlgItemInt, GetDlgItemText2
*/
@@ -9464,7 +9471,7 @@ MG_EXPORT int GUIAPI GetDlgItemText (HWND hDlg, LINT nIDDlgItem,
*
* \return The pointer to the allocated buffer.
*
* \note TODO
* \note The type of \a id changed from int to LINT since v3.2.
*
* \sa GetDlgItemText
*/
@@ -9529,7 +9536,7 @@ MG_EXPORT HWND GUIAPI GetNextDlgTabItem (HWND hDlg, HWND hCtl, BOOL bPrevious);
*
* \return The return value of the message handler.
*
* \note TODO
* \note The type of \a nIDDlgItem changed from int to LINT since v3.2.
*
* \sa SendMessage, GetDlgItem
*/
@@ -9554,7 +9561,7 @@ MG_EXPORT LRESULT GUIAPI SendDlgItemMessage (HWND hDlg, LINT nIDDlgItem,
*
* \return TRUE on success, FALSE on error.
*
* \note TODO
* \note The type of \a nIDDlgItem changed from int to LINT since v3.2.
*
* \sa GetDlgItemInt, SetDlgItemText
*/
@@ -9576,7 +9583,7 @@ MG_EXPORT BOOL GUIAPI SetDlgItemInt (HWND hDlg, LINT nIDDlgItem,
*
* \return TRUE on success, FALSE on error.
*
* \note TODO
* \note The type of \a nIDDlgItem changed from int to LINT since v3.2.
*
* \sa GetDlgItemText, SetDlgItemInt
*/
@@ -9605,7 +9612,7 @@ MG_EXPORT BOOL GUIAPI SetDlgItemText (HWND hDlg, LINT nIDDlgItem,
* - BST_INDETERMINATE\n
* The button is in indeterminate state.
*
* \note TODO
* \note The type of \a nIDDlgItem changed from int to LINT since v3.2.
*
* \sa CheckRadioButton, IsDlgButtonChecked
*/
@@ -9627,7 +9634,8 @@ MG_EXPORT void GUIAPI CheckDlgButton (HWND hDlg, LINT nIDDlgItem, int nCheck);
* \param idLastButton The identifier of the last control in the group.
* \param idCheckButton The identifier of the control to be checked.
*
* \note TODO
* \note The type of \a idFirstButton, \a idLastButton, and \a idCheckButton
* changed from int to LINT since v3.2.
*
* \sa CheckDlgButton
*/
@@ -9657,7 +9665,7 @@ MG_EXPORT void GUIAPI CheckRadioButton (HWND hDlg,
* - BST_INDETERMINATE\n
* The button is in indeterminate state.
*
* \note TODO
* \note The type of \a idButton tem changed from int to LINT since v3.2.
*
* \sa CheckDlgButton
*/