Don't document private event handlers in doc/view frame classes.

[wxWidgets.git] / docs / doxygen / mainpages / platdetails.h

diff --git a/docs/doxygen/mainpages/platdetails.h b/docs/doxygen/mainpages/platdetails.h
index f9f6be3c07646f77a5e258fddbb60982d131f18b..593eb18e40d47ed639d2aa5af6c804cc1663a942 100644 (file)
--- a/docs/doxygen/mainpages/platdetails.h
+++ b/docs/doxygen/mainpages/platdetails.h
@@ -3,7 +3,7 @@
 // Purpose:     Platform details page of the Doxygen manual
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     Platform details page of the Doxygen manual
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 
 /////////////////////////////////////////////////////////////////////////////
 
 


@@ -19,10 +19,8 @@ requires. This chapter collects notes about differences among supported platform
 and ports.
 
 @li @ref page_port_wxgtk
 and ports.
 
 @li @ref page_port_wxgtk

-@li @ref page_port_wxmac
-@li @ref page_port_wxcocoa
+@li @ref page_port_wxosx

 @li @ref page_port_wxos2
 @li @ref page_port_wxos2

-@li @ref page_port_wxmgl

 @li @ref page_port_wxx11
 @li @ref page_port_wxmotif
 @li @ref page_port_wxmsw
 @li @ref page_port_wxx11
 @li @ref page_port_wxmotif
 @li @ref page_port_wxmsw


@@ -71,72 +69,56 @@ For further information, please see the files in @c docs/gtk
 in the distribution.
 
 
 in the distribution.
 
 

-
-
-@section page_port_wxmac wxMac
+@section page_port_wxosx wxOSX

 
 @htmlonly
 <img src="logo_osxleopard.png" alt="Mac OS X (Leopard) logo"
     title="Mac OS X (Leopard) logo" class="logo">
 @endhtmlonly
 
 
 @htmlonly
 <img src="logo_osxleopard.png" alt="Mac OS X (Leopard) logo"
     title="Mac OS X (Leopard) logo" class="logo">
 @endhtmlonly
 

-wxMac is a port of wxWidgets for the Macintosh OS platform.
-Currently MacOS X 10.4 or higher are supported. wxMac can
+@subsection page_port_wxosx_carbon wxOSX/Carbon
+
+wxOSX/Carbon is a port of wxWidgets for the Macintosh OS platform.
+Currently MacOS X 10.4 or higher are supported. wxOSX/Carbon can

 be compiled both using Apple's command line developer tools
 be compiled both using Apple's command line developer tools

-as well as Apple's XCode IDE. wxMac supports both the Intel
+as well as Apple's Xcode IDE. wxOSX/Carbon supports both the Intel

 and PowerPC architectures and can be used to produce
 "universal binaries" in order create application which can run
 and PowerPC architectures and can be used to produce
 "universal binaries" in order create application which can run

-both architecture. Unfortunately, wxMac does not support any
+both architecture. Unfortunately, wxOSX/Carbon does not support any

 64-bit architecture since Apple decided not to port its Carbon
 API entirely to 64-bit.
 
 64-bit architecture since Apple decided not to port its Carbon
 API entirely to 64-bit.
 

-For further information, please see the files in @c docs/mac
-in the distribution.
-
-
-
-@section page_port_wxcocoa wxCocoa
-
-@htmlonly
-<img src="logo_osxleopard.png" alt="Mac OS X (Leopard) logo"
-    title="Mac OS X (Leopard) logo" class="logo">
-@endhtmlonly
-
-wxCocoa is another port of wxWidgets for the Macintosh OS
-platform. In contrast to wxMac, it uses the Cocoa API.
-Much work has gone into this port and many controls are
-functional, but the port has not reached the maturity
-of the wxMac port yet. It should be possible to use wxCocoa
-on 64-bit architectures.
+@note Carbon has been deprecated by Apple as of OS X 10.5 and will likely
+be removed entirely in a future OS version. It's recommended you look into
+switching your app over to wxOSX/Cocoa as soon as possible.

 
 

-For further information, please see the files in @c docs/mac
+For further information, please see the files in @c docs/osx

 in the distribution.
 
 
 in the distribution.
 
 

-@section page_port_wxmgl wxMGL

 
 

-wxMGL is a port of wxWidgets using the MGL library available
-from SciTech as the underlying graphics backend. wxMGL draws
-its widgets using the wxUniversal widget set which is part
-of wxWidgets. MGL itself runs on a variety of platforms
-including DOS, Linux hardware (similar to the Linux framebuffer)
-and various graphics systems such as Win32, X11 and OS/2.
-Note that currently MGL for Linux runs only on x86-based systems.
+@subsection page_port_wxosx_cocoa wxOSX/Cocoa

 
 

-You will MGL 5.0 or higher which is available from
-
-http://www.scitechsoft.com/products/product_download.html
+wxOSX/Cocoa is another port of wxWidgets for the Macintosh OS
+platform. In contrast to wxOSX/Carbon, it uses the Cocoa API 
+in place of Carbon. Much work has gone into this port and many 
+controls are functional, but the port has not reached the maturity
+of the wxOSX/Carbon port yet. It is possible to use wxOSX/Cocoa
+on 64-bit architectures.

 
 

-In order to configure wxWidgets to compile wxMGL you will
+In order to configure wxWidgets to compile wxOSX/Cocoa you will

 need to type:
 
 need to type:
 

-@verbatim configure --with-mgl --with-universal @endverbatim
+@verbatim configure --with-osx_cocoa @endverbatim

 
 

-Under DOS, wxMGL uses a dmake based make system.
-
-For further information, please see the files in @c docs/mgl
+For further information, please see the files in @c docs/osx

 in the distribution.
 
 in the distribution.
 

+@note There was a previous effort towards a Cocoa port called 
+wxCocoa, which was implemented totally with Cocoa API unlike the OSX/Cocoa port
+which uses OS X C APIs to share code, and while it is no longer being actively 
+developed, docs for it are available in @c docs/cocoa in the distribution.
+

 
 
 @section page_port_wxos2 wxOS2
 
 
 @section page_port_wxos2 wxOS2


@@ -635,9 +617,14 @@ used by wxWidgets to e.g. use toolkit-specific features.
 In such case (or when you want to e.g. write a port-specific patch) it can be
 necessary to use the underlying toolkit API directly:
 
 In such case (or when you want to e.g. write a port-specific patch) it can be
 necessary to use the underlying toolkit API directly:
 

-@li wxMSW port uses win32 API: see MSDN docs at http://msdn2.microsoft.com/en-us/library/ms649779.aspx
-@li wxGTK port uses GTK+: see GTK+ 2.x docs at http://developer.gnome.org/doc/API/2.0/gtk/index.html
-@li wxMac port uses the Carbon API: see Carbon docs at http://developer.apple.com/carbon
-@li wxCocoa port uses the Cocoa API: see Cocoa docs at http://developer.apple.com/cocoa
+- wxMSW port uses win32 API: see MSDN docs at http://msdn2.microsoft.com/en-us/library/ms649779.aspx
+- wxGTK port uses GTK+ and other lower-level libraries; see 
+  - GTK+ docs at http://library.gnome.org/devel/gtk/unstable/
+  - GDK docs at http://library.gnome.org/devel/gdk/unstable/
+  - GLib docs at http://library.gnome.org/devel/glib/unstable/
+  - GObject docs at http://library.gnome.org/devel/gobject/unstable/
+  - Pango docs at http://library.gnome.org/devel/pango/unstable/
+- wxMac port uses the Carbon API: see Carbon docs at http://developer.apple.com/carbon
+- wxCocoa port uses the Cocoa API: see Cocoa docs at http://developer.apple.com/cocoa

 
 */
 
 */