[MPlayer-cvslog] r35823 - in trunk/gui: app/gui.h util/bitmap.h util/cut.h util/list.h util/mem.h

[ib]

Author: ib
Date: Tue Jan 22 18:04:36 2013
New Revision: 35823

Log:
Revise some doxygen comments.

Modified:
   trunk/gui/app/gui.h
   trunk/gui/util/bitmap.h
   trunk/gui/util/cut.h
   trunk/gui/util/list.h
   trunk/gui/util/mem.h

Modified: trunk/gui/app/gui.h
==============================================================================
--- trunk/gui/app/gui.h	Tue Jan 22 16:37:17 2013	(r35822)
+++ trunk/gui/app/gui.h	Tue Jan 22 18:04:36 2013	(r35823)
@@ -25,20 +25,20 @@
 #define MPLAYER_GUI_GUI_H
 
 //@{
-/// boolean symbolic constant
+/// Boolean symbolic constant
 #if !defined(True) && !defined(False)
 #define True  1
 #define False 0
 #endif
 //@}
 
-/// a pseudo stream type indicating not to change the current one
+/// A pseudo stream type indicating not to change the current one
 #define SAME_STREAMTYPE (STREAMTYPE_DUMMY - 1)
 
 /// StreamTypes that are permitted in a playlist
 #define isPlaylistStreamtype (guiInfo.StreamType == STREAMTYPE_FILE || guiInfo.StreamType == STREAMTYPE_STREAM)
 
-/// check whether x/y is inside the rectangle given by top x/y and bottom x/y
+/// Check whether @a x/y is inside the rectangle given by @a top @a x/y and @a bottom @a x/y.
 #define isInside(x, y, tx, ty, bx, by) ((x) > (tx) && (y) > (ty) && (x) < (bx) && (y) < (by))
 
 #endif /* MPLAYER_GUI_GUI_H */

Modified: trunk/gui/util/bitmap.h
==============================================================================
--- trunk/gui/util/bitmap.h	Tue Jan 22 16:37:17 2013	(r35822)
+++ trunk/gui/util/bitmap.h	Tue Jan 22 18:04:36 2013	(r35823)
@@ -19,10 +19,7 @@
 #ifndef MPLAYER_GUI_BITMAP_H
 #define MPLAYER_GUI_BITMAP_H
 
-/**
- * @def GUI_TRANSPARENT
- * transparent color (opaque fuchsia/magenta)
- */
+/// Transparent color (opaque fuchsia/magenta)
 #define GUI_TRANSPARENT 0xffff00ff
 #define ALPHA_OPAQUE    0xff000000
 

Modified: trunk/gui/util/cut.h
==============================================================================
--- trunk/gui/util/cut.h	Tue Jan 22 16:37:17 2013	(r35822)
+++ trunk/gui/util/cut.h	Tue Jan 22 18:04:36 2013	(r35823)
@@ -22,9 +22,9 @@
 #include <stddef.h>
 
 /**
- * @def cutItem(in, out, sep, num)
- * Wraps #cutItemString():
- * Extract a part of a string delimited by a separator character at most the size of @a out.
+ * @brief Wraps #cutItemString():
+ *        Extract a part of a string delimited by a separator character
+ *        at most the size of @a out.
  */
 #define cutItem(in, out, sep, num) cutItemString(in, out, sep, num, sizeof(out))
 

Modified: trunk/gui/util/list.h
==============================================================================
--- trunk/gui/util/list.h	Tue Jan 22 16:37:17 2013	(r35822)
+++ trunk/gui/util/list.h	Tue Jan 22 18:04:36 2013	(r35823)
@@ -48,16 +48,16 @@ typedef struct urlItem {
     struct urlItem *next;
 } urlItem;
 
-/// @name list manager (playlist, URL list)
+/// @name List manager (playlist, URL list)
 void *listMgr(int cmd, void *data);
 
-/// @name char pointer list operations
+/// @name Char pointer list operations
 //@{
 void listRepl(char ***list, const char *search, const char *replace);
 void listSet(char ***list, const char *entry);
 //@}
 
-/// @name high-level list operations
+/// @name High-level list operations
 //@{
 int add_to_gui_playlist(const char *what, int how);
 //@}

Modified: trunk/gui/util/mem.h
==============================================================================
--- trunk/gui/util/mem.h	Tue Jan 22 16:37:17 2013	(r35822)
+++ trunk/gui/util/mem.h	Tue Jan 22 18:04:36 2013	(r35823)
@@ -26,10 +26,7 @@
 
 #include <stdlib.h>
 
-/**
- * @def nfree(p)
- * Free @a p and set it to NULL.
- */
+/// Free @a p and set it to NULL.
 #define nfree(p) do { free(p); p = NULL; } while (0)
 
 #endif /* MPLAYER_GUI_MEM_H */