cefclient: Fix/improve source code documentation (issue #1500).

git-svn-id: http://chromiumembedded.googlecode.com/svn/trunk/cef3@2019 5089003a-bbd8-11dd-ad1f-f1f9622dbc98

Author: [email protected]

tests/cefclient/browser/binding_test.h

@@ -11,7 +11,7 @@
 namespace client {
 namespace binding_test {
 
-// Handler creation.
+// Create message handlers. Called from test_runner.cc.
 void CreateMessageHandlers(test_runner::MessageHandlerSet& handlers);
 
 }  // namespace binding_test

tests/cefclient/browser/browser_window.h

@@ -18,14 +18,14 @@ namespace client {
 // indicated.
 class BrowserWindow : public ClientHandler::Delegate {
  public:
-  // This interface is implemented by the owner of the BrowserWindowWin. The
+  // This interface is implemented by the owner of the BrowserWindow. The
   // methods of this class will be called on the main thread.
   class Delegate {
    public:
     // Called when the browser has been created.
     virtual void OnBrowserCreated(CefRefPtr<CefBrowser> browser) = 0;
 
-    // Called when the BrowserWindowWin has been destroyed.
+    // Called when the BrowserWindow has been destroyed.
     virtual void OnBrowserWindowDestroyed() = 0;
 
     // Set the window URL address.
@@ -88,7 +88,7 @@ class BrowserWindow : public ClientHandler::Delegate {
   friend struct base::DefaultDeleter<BrowserWindow>;
 
   // Constructor may be called on any thread.
-  // |root_window| and |delegate| must outlive this object.
+  // |delegate| must outlive this object.
   explicit BrowserWindow(Delegate* delegate);
 
   // ClientHandler::Delegate methods.

tests/cefclient/browser/client_app_browser.h

@@ -37,11 +37,12 @@ class ClientAppBrowser : public ClientApp,
   ClientAppBrowser();
 
  private:
-  // Creates all of the Delegate objects. Implemented in
-  // client_app_delegates.
+  // Creates all of the Delegate objects. Implemented by cefclient in
+  // client_app_delegates_browser.cc
   static void CreateDelegates(DelegateSet& delegates);
 
-  // Create the Linux print handler. Implemented in client_app_delegates.
+  // Create the Linux print handler. Implemented by cefclient in
+  // client_app_delegates_browser.cc
   static CefRefPtr<CefPrintHandler> CreatePrintHandler();
 
   // CefApp methods.

tests/cefclient/browser/dialog_test.h

@@ -11,7 +11,7 @@
 namespace client {
 namespace dialog_test {
 
-/// Handler creation.
+// Create message handlers. Called from test_runner.cc.
 void CreateMessageHandlers(test_runner::MessageHandlerSet& handlers);
 
 }  // namespace dialog_test

tests/cefclient/browser/root_window.h

@@ -53,8 +53,8 @@ class RootWindow :
   static scoped_refptr<RootWindow> GetForNSWindow(NSWindow* window);
 #endif
 
-  // Initialize as a normal window. This will create and show a browser window.
-  // This method may be called on any thread.
+  // Initialize as a normal window. This will create and show a native window
+  // hosting a single browser instance. This method may be called on any thread.
   // |delegate| must be non-NULL and outlive this object.
   // Use RootWindowManager::CreateRootWindow() instead of calling this method
   // directly.
@@ -65,10 +65,10 @@ class RootWindow :
                     const CefBrowserSettings& settings,
                     const std::string& url) = 0;
 
-  // Initialize as a popup window. This is used to attach a browser window that
-  // will be created later. The window will be shown once the browser is
-  // available. This method may be called on any thread.
-  // |delegate| must be non-NULL and outlive this object.
+  // Initialize as a popup window. This is used to attach a new native window to
+  // a single browser instance that will be created later. The native window
+  // will be created and shown once the browser is available. This method may be
+  // called on any thread. |delegate| must be non-NULL and outlive this object.
   // Use RootWindowManager::CreateRootWindowAsPopup() instead of calling this
   // method directly.
   virtual void InitAsPopup(RootWindow::Delegate* delegate,
@@ -101,7 +101,7 @@ class RootWindow :
   // Returns the browser that this window contains, if any.
   virtual CefRefPtr<CefBrowser> GetBrowser() const = 0;
 
-  // Returns the handle for this window, if any.
+  // Returns the native handle for this window, if any.
   virtual ClientWindowHandle GetWindowHandle() const = 0;
 
  protected:

tests/cefclient/browser/root_window_manager.h

@@ -26,7 +26,7 @@ class RootWindowManager : public RootWindow::Delegate {
   // Create a new top-level native window that loads |url|.
   // If |with_controls| is true the window will show controls.
   // If |with_osr| is true the window will use off-screen rendering.
-  // If |bounds| is empty the default window size will be used.
+  // If |bounds| is empty the default window size and location will be used.
   // This method can be called from anywhere to create a new top-level window.
   scoped_refptr<RootWindow> CreateRootWindow(
       bool with_controls,

tests/cefclient/browser/scheme_test.h

@@ -9,7 +9,9 @@
 namespace client {
 namespace scheme_test {
 
-// Create the scheme handler. Called from both the browser and renderer process.
+// Create and register the custom scheme handler. See
+// common/scheme_handler_common.h for registration of the custom scheme
+// name/type which must occur in all processes. Called from test_runner.cc.
 void RegisterSchemeHandlers();
 
 }  // namespace scheme_test

tests/cefclient/browser/window_test.h

@@ -11,7 +11,7 @@
 namespace client {
 namespace window_test {
 
-/// Handler creation.
+// Create message handlers. Called from test_runner.cc.
 void CreateMessageHandlers(test_runner::MessageHandlerSet& handlers);
 
 // Fit |window| inside |display|. Coordinates are relative to the upper-left

tests/cefclient/common/client_app.h

@@ -32,7 +32,8 @@ class ClientApp : public CefApp {
   std::vector<CefString> cookieable_schemes_;
 
  private:
-  // Registers custom schemes. Implemented in client_app_delegates.
+  // Registers custom schemes. Implemented by cefclient in
+  // client_app_delegates_common.cc
   static void RegisterCustomSchemes(CefRefPtr<CefSchemeRegistrar> registrar,
                                     std::vector<CefString>& cookiable_schemes);
 

tests/cefclient/common/scheme_test_common.h

@@ -13,7 +13,10 @@
 namespace client {
 namespace scheme_test {
 
-// Register the scheme.
+// Register the custom scheme name/type. This must be done in all processes.
+// See browser/scheme_test.h for creation/registration of the custom scheme
+// handler which only occurs in the browser process. Called from
+// client_app_delegates_common.cc.
 void RegisterCustomSchemes(CefRefPtr<CefSchemeRegistrar> registrar,
                            std::vector<CefString>& cookiable_schemes);
 

tests/cefclient/renderer/client_app_renderer.h

@@ -86,8 +86,8 @@ class ClientAppRenderer : public ClientApp,
   ClientAppRenderer();
 
  private:
-  // Creates all of the Delegate objects. Implemented in
-  // client_app_delegates.
+  // Creates all of the Delegate objects. Implemented by cefclient in
+  // client_app_delegates_renderer.cc
   static void CreateDelegates(DelegateSet& delegates);
 
   // CefApp methods.

tests/cefclient/renderer/client_renderer.h

@@ -12,7 +12,7 @@
 namespace client {
 namespace renderer {
 
-// Create the render delegate.
+// Create the renderer delegate. Called from client_app_delegates_renderer.cc.
 void CreateDelegates(ClientAppRenderer::DelegateSet& delegates);
 
 }  // namespace renderer

tests/cefclient/renderer/performance_test.h

@@ -11,7 +11,7 @@
 namespace client {
 namespace performance_test {
 
-// Render delegate creation. Called from client_app_delegates.cc.
+// Create the renderer delegate. Called from client_app_delegates_renderer.cc.
 void CreateDelegates(ClientAppRenderer::DelegateSet& delegates);
 
 }  // namespace performance_test