tune doxygen words

configure.ac

@@ -502,7 +502,7 @@ AC_ARG_ENABLE(consolegpm,
 build_console_gpm=$enableval)
 
 AC_ARG_ENABLE(textmode,
-[  --enable-textmode        Linux system have console (text mode) on Frame Buffer <default=yes>],
+[  --enable-textmode        Linux system has console (text mode) on Frame Buffer <default=yes>],
 build_text_mode=$enableval)
 
 AC_ARG_ENABLE(rbfsupport,

examples/createvirtualwindow.c

@@ -0,0 +1,24 @@
+/*
+ * The following code creates a virtual window.
+ */
+static LRESULT
+my_virt_wnd_proc (HWND hwnd, UINT message, WPARAM wparam, LPARAM lparam)
+{
+    switch (message) {
+        ...
+    }
+
+    return DefaultVirtualWinProc (hwnd, message, wparam, lparam);
+}
+
+...
+
+    HWND new_wnd = CreateVirtualWindow (HWND_NULL, my_virt_wnd_proc,
+            "A Virtual Window", 0, 0);
+
+    if (new_wnd != HWND_INVALID) {
+        // failed to create the virtual window.
+    }
+
+    // go on...
+    ...

include/gdi.h

@@ -1464,7 +1464,7 @@ MG_EXPORT Uint32 GUIAPI GetGDCapability (HDC hdc, int iItem);
  * the internal DC pool, rather than allocating a new one from the system heap.
  * Thus, you should release the DC when you finish drawing as soon as possible.
  *
- * \param hwnd The handle to the window.
+ * \param hWnd The handle to the window.
  * \param bClient Whether to initialize as a window or a client DC;
  *  TRUE for client DC, FALSE for window DC.
  *
@@ -1476,7 +1476,7 @@ MG_EXPORT Uint32 GUIAPI GetGDCapability (HDC hdc, int iItem);
  *
  * Since 5.0.0
  */
-MG_EXPORT HDC GUIAPI GetDCEx (HWND hwnd, BOOL bClient);
+MG_EXPORT HDC GUIAPI GetDCEx (HWND hWnd, BOOL bClient);
 
 /**
  * \fn HDC GUIAPI GetDC (HWND hWnd)
@@ -5575,7 +5575,7 @@ MG_EXPORT BOOL GUIAPI SaveMainWindowContent (HWND hWnd, const char* filename);
 
 /**
  * \fn HICON GUIAPI LoadIconFromFile (HDC hdc, const char* filename, int which)
- * \brief Loads an icon from a Windows ICO file.
+ * \brief Load an icon from a Windows ICO file.
  *
  * This function loads an icon from a Windows ICO file named \a filename
  * and creates an icon object. This function can load monochrome, 16-color,
@@ -5596,7 +5596,7 @@ MG_EXPORT HICON GUIAPI LoadIconFromFile (HDC hdc, const char* filename,
 
 /**
  * \fn HICON GUIAPI LoadIconFromMem (HDC hdc, const void* area, int which)
- * \brief Loads an icon from a memory area.
+ * \brief Load an icon from a memory area.
  *
  * This function loads an icon from a memroy area pointed to by \a area.
  * The memory area has the same layout as the M$ Windows ICO file.
@@ -5650,7 +5650,7 @@ MG_EXPORT HICON GUIAPI CreateIconEx (HDC hdc, int w, int h,
 
 /**
  * \fn HICON GUIAPI LoadBitmapIconEx (MG_RWops* area, const char* ext)
- * \brief Loads an icon from a general bitmap data source.
+ * \brief Load an icon from a general bitmap data source.
  *
  * This function loads an icon from the data source \a area, which contains
  * the data of a bitmap in a specific type specified by \a ext.
@@ -5667,8 +5667,8 @@ MG_EXPORT HICON GUIAPI LoadBitmapIconEx (HDC hdc, MG_RWops* area,
         const char* ext);
 
 /**
- * \fn HICON GUIAPI LoadBitmapIconFromFile (HDC hdc, const char* spFileName)
- * \brief Loads an icon from a bitmap file.
+ * \fn HICON GUIAPI LoadBitmapIconFromFile (HDC hdc, const char* file_name)
+ * \brief Load an icon from a bitmap file.
  *
  * This function loads an icon from a bitmap file specified by \a file_name.
  *
@@ -5685,7 +5685,7 @@ MG_EXPORT HICON GUIAPI LoadBitmapIconFromFile (HDC hdc,
 /**
  * \fn HICON GUIAPI LoadBitmapIconFromMem (HDC hdc, const void* mem, size_t size,
  *      const char* ext)
- * \brief Loads an icon from memory.
+ * \brief Load an icon from memory.
  *
  * This function loads an icon from a memory zone specified by \a mem
  * and \a size.
@@ -11223,7 +11223,7 @@ MG_EXPORT BOOL GUIAPI mlsEnableSlaveScreen (HDC dc_mls, BOOL enable);
  * \fn int GUIAPI LoadBitmapEx2 (HDC hdc, PBITMAP pBitmap,
                 MG_RWops* area, const char* ext,
                 CB_ALLOC_BITMAP_BUFF cb_alloc_buff, void* context)
- * \brief Loads a device-dependent bitmap from a general data source.
+ * \brief Load a device-dependent bitmap from a general data source.
  *
  * This function loads a device-dependent bitmap from the data source \a area.
  * This function gives a chance to the caller to allocate the pixel buffer
@@ -11260,7 +11260,7 @@ MG_EXPORT int GUIAPI LoadBitmapEx2 (HDC hdc, PBITMAP pBitmap,
 /**
  * \fn int GUIAPI LoadBitmapEx (HDC hdc, PBITMAP pBitmap, \
                 MG_RWops* area, const char* ext)
- * \brief Loads a device-dependent bitmap from a general data source.
+ * \brief Load a device-dependent bitmap from a general data source.
  *
  * This function loads a device-dependent bitmap from the data source \a area.
  *
@@ -11292,7 +11292,7 @@ static inline int LoadBitmapEx (HDC hdc, PBITMAP pBitmap,
 /**
  * \fn int GUIAPI LoadBitmapFromFile (HDC hdc, PBITMAP pBitmap, \
                 const char* spFileName)
- * \brief Loads a device-dependent bitmap from a file.
+ * \brief Load a device-dependent bitmap from a file.
  *
  * \sa LoadBitmapEx
  */
@@ -11310,7 +11310,7 @@ MG_EXPORT int GUIAPI LoadBitmapFromFile (HDC hdc, PBITMAP pBitmap,
 /**
  * \fn int GUIAPI LoadBitmapFromMem (HDC hdc, PBITMAP pBitmap, \
                 const void* mem, size_t size, const char* ext)
- * \brief Loads a device-dependent bitmap from memory.
+ * \brief Load a device-dependent bitmap from memory.
  *
  * \sa LoadBitmapEx
  */
@@ -11413,7 +11413,7 @@ MG_EXPORT void* GUIAPI InitMyBitmapSL (MG_RWops* area,
 /**
  * \fn int GUIAPI LoadMyBitmapSL (MG_RWops* area, void* load_info, \
                 MYBITMAP* my_bmp, CB_ONE_SCANLINE cb, void* context)
- * \brief Loads MYBITMAP scanlines from a data source one by one.
+ * \brief Load MYBITMAP scanlines from a data source one by one.
  *
  * This function loads MYBITMAP scanlines from the data source \a area
  * one by one.
@@ -11450,7 +11450,7 @@ MG_EXPORT int GUIAPI CleanupMyBitmapSL (MYBITMAP* my_bmp, void* load_info);
 /**
  * \fn int GUIAPI LoadMyBitmapEx (PMYBITMAP my_bmp, RGB* pal, \
                 MG_RWops* area, const char* ext)
- * \brief Loads a MYBITMAP object from a data source.
+ * \brief Load a MYBITMAP object from a data source.
  *
  * This function loads a MYBITMAP object from the data source \a area.
  *
@@ -11468,7 +11468,7 @@ MG_EXPORT int GUIAPI LoadMyBitmapEx (PMYBITMAP my_bmp, RGB* pal,
 /**
  * \fn int GUIAPI LoadMyBitmapFromFile (PMYBITMAP my_bmp, RGB* pal, \
                 const char* file_name)
- * \brief Loads a MYBITMAP object from a file.
+ * \brief Load a MYBITMAP object from a file.
  *
  * \sa LoadMyBitmapEx
  */
@@ -11486,7 +11486,7 @@ MG_EXPORT int GUIAPI LoadMyBitmapFromFile (PMYBITMAP my_bmp, RGB* pal,
 /**
  * \fn int GUIAPI LoadMyBitmapFromMem (PMYBITMAP my_bmp, RGB* pal, \
                 const void* mem, size_t size, const char* ext)
- * \brief Loads a MYBITMAP object from memory.
+ * \brief Load a MYBITMAP object from memory.
  *
  * This function loads a MYBITMAP object from memory.
  *

include/minigui.h

@@ -789,7 +789,7 @@ extern MG_EXPORT ON_CHANGE_LAYER OnChangeLayer;
  * The event will be passed through the argument of \a op; the
  * pointers to the layer, the identifier of the client, and the index of
  * the z-node will be passed through the argument of \a layer, \a cli,
- * and \a idx_z-node respectively.
+ * and \a idx_znode respectively.
  *
  * \note Only available for the server of MiniGUI-Processes.
  *
@@ -895,11 +895,11 @@ MG_EXPORT BOOL GUIAPI ServerDeleteLayer (MG_Layer* layer);
  * \brief Get the next z-node in the specified layer from the server.
  *
  * This function gets the next z-node of the z-node specified by
- * \a idx_z-node, i.e., the z-node below it, in the specified layer
+ * \a idx_znode, i.e., the z-node below it, in the specified layer
  * \a layer from the server.
  *
  * \param layer The pointer to the layer, NULL for the current topmost layer.
- * \param idx_z-node The initial z-node. If the initial z-node index is
+ * \param idx_znode The initial z-node. If the initial z-node index is
  *        less than or equal to zero, the function will return
  *        the index of the first (the topmost) z-node in the layer.
  * \param cli The client identifier of the next z-node will be returned
@@ -1389,7 +1389,7 @@ MG_EXPORT BOOL GUIAPI ServerSetWinZNodePrivateData (MG_Layer* layer,
         int idx_znode, void* priv_data);
 
 /**
- * \fn BOOL GUIAPI ServerSetPopupMenuZNodePrivateData (int idx,
+ * \fn BOOL GUIAPI ServerSetPopupMenuZNodePrivateData (int idx_znode,
         void* priv_data)
  * \brief Set the private data of the z-node of the specific popup menu.
  *
@@ -1407,7 +1407,7 @@ MG_EXPORT BOOL GUIAPI ServerSetWinZNodePrivateData (MG_Layer* layer,
  *
  * Since 5.0.0
  */
-MG_EXPORT BOOL GUIAPI ServerSetPopupMenuZNodePrivateData (int idx,
+MG_EXPORT BOOL GUIAPI ServerSetPopupMenuZNodePrivateData (int idx_znode,
         void* priv_data);
 
 /**
@@ -1734,7 +1734,6 @@ MG_EXPORT BOOL GUIAPI ServerRegisterCompositor (
  * This function un-registers a compositor.
  *
  * \param name The name of the compositor.
- * \param ops The new compositor object.
  *
  * \return The object represents the compositor implementation.
  *
@@ -2124,7 +2123,7 @@ MG_EXPORT REQ_HANDLER GUIAPI GetRequestHandler (int req_id);
 MG_EXPORT REQ_HANDLER_V1 GUIAPI GetRequestHandlerV1 (int req_id);
 
 /**
- * \fn void* GUIAPI GetRequestHandlerEx (int req_id, int* handler_ver)
+ * \fn void* GUIAPI GetRequestHandlerEx (int req_id, int* version)
  * \brief Get the request handler and the version by request identifier.
  *
  * This function returns the request handler and the version of

include/window.h

@@ -7205,6 +7205,7 @@ MG_EXPORT BOOL GUIAPI SetMainWindowAlwaysTop (HWND hWnd, BOOL fSet);
  *      other; thus, a larger value will create more blur. A value of 0 leaves
  *      the input unchanged. Note that the built-in `fallback` compositor
  *      does not support this compositing type.
+ * \param arg The compositing argument.
  *
  * \return return TRUE on success, otherwise FALSE.
  *