From 062dfc9a96dc9e796c53544f41ff92dc47f26e82 Mon Sep 17 00:00:00 2001
From: Steve Lamerton <steve.lamerton@gmail.com>
Date: Mon, 8 Aug 2011 12:05:58 +0000
Subject: [PATCH] Add backend descriptions for all backends to the
 documentation.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/SOC2011_WEBVIEW@68600 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---
 interface/wx/webview.h | 36 +++++++++++++++++++++++++++++-------
 1 file changed, 29 insertions(+), 7 deletions(-)

diff --git a/interface/wx/webview.h b/interface/wx/webview.h
index eaa2a5c77a..169d601b08 100644
--- a/interface/wx/webview.h
+++ b/interface/wx/webview.h
@@ -145,14 +145,36 @@ public:
     @class wxWebView
   
     This control may be used to render web (HTML / CSS / javascript) documents.
-    Capabilities of the HTML renderer will depend upon the backed.
-
-    @c wxWEB_VIEW_BACKEND_IE uses the the Trident rendering engine, which 
-    is also used by Internet Explorer. It is important to note that by default 
-    it emulates Internet Explorer 7, this can be chaged with a registry 
-    setting, see 
+    
+    @section descriptions Backend Descriptions
+    
+    @par wxWEB_VIEW_BACKEND_IE (MSW)
+    
+    The IE backend uses Microsoft's Trident rendering engine, specifically the 
+    version used by the locally installed copy of Internet Explorer. As such it
+    is only avaliable for the MSW port. By default recent versions of of the 
+    <a href="http://msdn.microsoft.com/en-us/library/aa752085%28v=VS.85%29.aspx">WebBrowser</a>
+    control, which this backend uses, emulate Internet Explorer 7. This can be
+    chaged with a registry setting, see 
     <a href="http://msdn.microsoft.com/en-us/library/ee330730%28v=vs.85%29.aspx#browser_emulation">
-    this</a> article for more information.
+    this</a> article for more information. This backend has full support for
+    custom schemes and virtual file systems.
+    
+    @par wxWEB_VIEW_WEBKIT (GTK)
+    
+    Under GTK the WebKit backend uses 
+    <a href="http://webkitgtk.org/">WebKitGTK+</a>. The current minimum version
+    requirent is 1.3.1 which ships by defult with Ubuntu Natty and Debian 
+    Wheezy and has the package name libwebkitgtk-dev. Custom schemes and virtual
+    files systems are supported under this backend, however embedded resources 
+    such as images and stylesheets are currently extracted to a temporary file
+    before being loaded.
+    
+    @par wxWEB_VIEW_WEBKIT (OSX)
+    
+    The OSX WebKit backend uses Apple's 
+    <a href="http://developer.apple.com/library/mac/#documentation/Cocoa/Reference/WebKit/Classes/WebView_Class/Reference/Reference.html#//apple_ref/doc/uid/20001903">WebView</a>
+    class. Currently it does not support custom shemes and virtual file systems.
 
     @section async Asynchronous Notifications
     
-- 
2.47.2