removed @NULL,@true,@false tags from the function prototypes; fixed * and & displacin...

[wxWidgets.git] / interface / defs.h

diff --git a/interface/defs.h b/interface/defs.h
index 2f6dcf212b24c0328cccd67fcad8e862b521bead..972f52c6be3682488f98852ea1cdb80beee8a229 100644 (file)
--- a/interface/defs.h
+++ b/interface/defs.h
@@ -8,7 +8,7 @@
 
 //@{
 /**
-    These macros will swap the bytes of the @e value variable from little
+    These macros will swap the bytes of the @a value variable from little
     endian to big endian or vice versa unconditionally, i.e. independently of the
     current platform.
 */
@@ -21,11 +21,10 @@ wxUint16 wxUINT16_SWAP_ALWAYS(wxUint16 value);
 
 //@{
 /**
-    This macro will swap the bytes of the @e value variable from little
+    This macro will swap the bytes of the @a value variable from little
     endian to big endian or vice versa if the program is compiled on a
     little-endian architecture (such as Intel PCs). If the program has
     been compiled on a big-endian architecture, the value will be unchanged.
-
     Use these macros to read data from and write data to a file that stores
     data in big-endian format.
 */
@@ -37,9 +36,8 @@ wxUint16 wxUINT16_SWAP_ON_LE(wxUint16 value);
 
 /**
     This macro is similar to wxDEPRECATED but can be used
-    to not only declare the function @e func as deprecated but to also provide
+    to not only declare the function @a func as deprecated but to also provide
     its (inline) implementation @e body.
-
     It can be used as following:
 
     @code
@@ -52,7 +50,7 @@ wxUint16 wxUINT16_SWAP_ON_LE(wxUint16 value);
         };
     @endcode
 */
-#define wxDEPRECATED_INLINE(func,  body)     /* implementation is private */
+#define wxDEPRECATED_INLINE(func, body)     /* implementation is private */
 
 /**
     @c wxEXPLICIT is a macro which expands to the C++ @c explicit keyword if
@@ -67,9 +65,10 @@ wxUint16 wxUINT16_SWAP_ON_LE(wxUint16 value);
     unless it has a friend. This warning may sometimes be useful but it doesn't
     make sense for reference counted class which always delete themselves (hence
     destructor should be private) but don't necessarily have any friends, so this
-    macro is provided to disable the warning in such case. The @e name parameter
+    macro is provided to disable the warning in such case. The @a name parameter
     should be the name of the class but is only used to construct a unique friend
     class name internally. Example of using the macro:
+
     @code
     class RefCounted
         {
@@ -91,11 +90,10 @@ wxUint16 wxUINT16_SWAP_ON_LE(wxUint16 value);
 
 //@{
 /**
-    This macro will swap the bytes of the @e value variable from little
+    This macro will swap the bytes of the @a value variable from little
     endian to big endian or vice versa if the program is compiled on a
     big-endian architecture (such as Sun work stations). If the program has
     been compiled on a little-endian architecture, the value will be unchanged.
-
     Use these macros to read data from and write data to a file that stores
     data in little-endian (for example Intel i386) format.
 */
@@ -110,7 +108,6 @@ wxUint16 wxUINT16_SWAP_ON_BE(wxUint16 value);
     indicating that this function is deprecated (i.e. obsolete and planned to be
     removed in the future) when it is used. Only Visual C++ 7 and higher and g++
     compilers currently support this functionality.
-
     Example of use:
 
     @code
@@ -128,7 +125,6 @@ wxUint16 wxUINT16_SWAP_ON_BE(wxUint16 value);
     which support it or its replacement for those that don't. It must be used to
     preserve the value of a @c va_list object if you need to use it after
     passing it to another function because it can be modified by the latter.
-
     As with @c va_start, each call to @c wxVaCopy must have a matching
     @c va_end.
 */