better Doxygen documentation of icon()

2008-12-21 14:07:20 +00:00
parent 55147836eb
commit 175e4c7b4f
12 changed files with 24 additions and 12 deletions
@@ -556,7 +556,8 @@ curses_hbar (Driver *drvthis, int x, int y, int len, int promille, int options)
 * \param x        Horizontal character position (column).
 * \param y        Vertical character position (row).
 * \param icon     synbolic value representing the icon.
- * \return  Information whether the icon is handled here or needs to be handled by the server core.
+ * \retval 0       Icon has been successfully defined/written.
+ * \retval <0      Server core shall define/write the icon.
 */
 MODULE_EXPORT int
 curses_icon (Driver *drvthis, int x, int y, int icon)