fixed confusingly complicated sentence to make sense

[wxWidgets.git] / interface / platform.h

diff --git a/interface/platform.h b/interface/platform.h
index 31a871d03ef99b334dbd6fba1ca15df8799151e1..73ff643e010d9ab73900bb751515a79ca3311559 100644 (file)
--- a/interface/platform.h
+++ b/interface/platform.h
@@ -1,56 +1,46 @@
 /////////////////////////////////////////////////////////////////////////////
-    // Name:        platform.h
-    // Purpose:     documentation for global functions
-    // Author:      wxWidgets team
-    // RCS-ID:      $Id$
-    // Licence:     wxWindows license
-    /////////////////////////////////////////////////////////////////////////////
-    
-    /**
-    Same as wxCHECK_VERSION but also checks that
-    @c wxSUBRELEASE_NUMBER is at least @e subrel.
-*/
-#define bool wxCHECK_VERSION_FULL(major, minor, release, subrel)     /* implementation is private */
-
-
-    /**
-    This is a macro which evaluates to @true if the current wxWidgets version is at
-    least major.minor.release.
-    
-    For example, to test if the program is compiled with wxWidgets 2.2 or higher,
-    the following can be done:
-    @code
-    wxString s;
-    #if wxCHECK_VERSION(2, 2, 0)
-        if ( s.StartsWith("foo") )
-    #else // replacement code for old version
-        if ( strncmp(s, "foo", 3) == 0 )
-    #endif
-        {
-            ...
-        }
-    @endcode
+// Name:        platform.h
+// Purpose:     interface of global functions
+// Author:      wxWidgets team
+// RCS-ID:      $Id$
+// Licence:     wxWindows license
+/////////////////////////////////////////////////////////////////////////////
+
+/** @ingroup group_funcmacro_version */
+//@{
+
+/**
+    Returns @true if the compiler being used is GNU C++ and its version is
+    at least major.minor or greater. Returns @false otherwise.
+
+    @header{wx/platform.h}
 */
-#define bool wxCHECK_VERSION(major, minor, release)     /* implementation is private */
+#define wxCHECK_GCC_VERSION( major, minor )
 
 /**
-    Returns 1 if the compiler being used to compile the code is Visual C++
-    compiler version @e major or greater. Otherwise, and also if
-    the compiler is not Visual C++ at all, returns 0.
+    Returns @true if the compiler being used is Sun CC Pro and its version is
+    at least major.minor or greater. Returns @false otherwise.
+
+    @header{wx/platform.h}
 */
-#define bool wxCHECK_VISUALC_VERSION(major)     /* implementation is private */
+#define wxCHECK_SUNCC_VERSION( major, minor )
 
 /**
-    Returns 1 if the compiler being used to compile the code is GNU C++
-    compiler (g++) version major.minor or greater. Otherwise, and also if
-    the compiler is not GNU C++ at all, returns 0.
+    Returns @true if the compiler being used is Visual C++ and its version is
+    at least major or greater. Returns @false otherwise.
+
+    @header{wx/platform.h}
 */
-#define bool wxCHECK_GCC_VERSION(major, minor)     /* implementation is private */
+#define wxCHECK_VISUALC_VERSION( major )
 
 /**
-    Returns 1 if the compiler being used to compile the code is Sun CC Pro
-    compiler and its version is at least @c major.minor. Otherwise returns
-    0.
+    Returns @true if the version of w32api headers used is major.minor or
+    greater. Otherwise, and also if we are not compiling with MinGW32/Cygwin
+    under Win32 at all, returns @false.
+
+    @header{wx/platform.h}
 */
-#define bool wxCHECK_SUNCC_VERSION(major, minor)     /* implementation is private */
+#define wxCHECK_W32API_VERSION( major, minor )
+
+//@}