use doxygen autolinking feature; use @ref command for the overview

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

diff --git a/docs/doxygen/mainpages/platdetails.h b/docs/doxygen/mainpages/platdetails.h
index 8d74c85f7eac850dff2a921c3ffa7a4f88bf27e5..7a25cd4c1007c834db1b038c0fe3226b59b13869 100644 (file)
--- a/docs/doxygen/mainpages/platdetails.h
+++ b/docs/doxygen/mainpages/platdetails.h
@@ -19,8 +19,7 @@ requires. This chapter collects notes about differences among supported platform
 and ports.
 
 @li @ref page_port_wxgtk
-@li @ref page_port_wxosx_carbon
-@li @ref page_port_wxosx_cocoa
+@li @ref page_port_wxosx
 @li @ref page_port_wxos2
 @li @ref page_port_wxmgl
 @li @ref page_port_wxx11
@@ -71,15 +70,15 @@ For further information, please see the files in @c docs/gtk
 in the distribution.
 
 
-
-
-@section page_port_wxosx_carbon wxOSX/Carbon
+@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
 
+@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
@@ -90,32 +89,36 @@ 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.
 
+@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/osx
 in the distribution.
 
 
 
-@section page_port_wxosx_cocoa wxOSX/Cocoa
-
-@htmlonly
-<img src="logo_osxleopard.png" alt="Mac OS X (Leopard) logo"
-    title="Mac OS X (Leopard) logo" class="logo">
-@endhtmlonly
+@subsection page_port_wxosx_cocoa wxOSX/Cocoa
 
 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/Cocoa port yet. It is possible to use wxOSX/Cocoa
+of the wxOSX/Carbon port yet. It is possible to use wxOSX/Cocoa
 on 64-bit architectures.
 
+In order to configure wxWidgets to compile wxOSX/Cocoa you will
+need to type:
+
+@verbatim configure --with-osx_cocoa @endverbatim
+
 For further information, please see the files in @c docs/osx
 in the distribution.
 
-Note that there was a previous effort towards a Cocoa port called 
-wxCocoa, which is implemented totally with Cocoa API unlike the OSX/Cocoa port
+@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 at @c docs/cocoa in the distribution.
+developed, docs for it are available in @c docs/cocoa in the distribution.
 
 
 
@@ -641,9 +644,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:
 
-@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
 
 */