From 10a67c12d7cff7b3df6e98c9dabb6ec77353ad01 Mon Sep 17 00:00:00 2001
From: "jond@google.com" <jond@google.com@0039d316-1c4b-4281-b951-d872f2087c98>
Date: Wed, 4 Jan 2012 19:41:10 +0000
Subject: New CPP docs for mouse lock and fullscreen. The docs are identical to
 those found in the C IDL with the exception of class descriptions and a
 CPP-specific types

Review URL: http://codereview.chromium.org/9018032

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@116358 0039d316-1c4b-4281-b951-d872f2087c98
---
 ppapi/cpp/fullscreen.h | 46 ++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 44 insertions(+), 2 deletions(-)

(limited to 'ppapi/cpp/fullscreen.h')

diff --git a/ppapi/cpp/fullscreen.h b/ppapi/cpp/fullscreen.h
index cb6a4f3..18ae43d 100644
--- a/ppapi/cpp/fullscreen.h
+++ b/ppapi/cpp/fullscreen.h
@@ -1,23 +1,65 @@
-// Copyright (c) 2011 The Chromium Authors. All rights reserved.
+// Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef PPAPI_CPP_FULLSCREEN_H_
 #define PPAPI_CPP_FULLSCREEN_H_
 
+/// @file
+/// This file defines the API for handling transitions of a module instance to
+/// and from fullscreen mode.
+
 namespace pp {
 
 class Instance;
 class Size;
 
+/// The Fullscreen class allowing you to check and toggle fullscreen mode.
 class Fullscreen {
  public:
+  /// A constructor for creating a <code>Fullscreen</code>.
+  ///
+  /// @param[in] instance The instance that will own the new
+  /// <code>Fullscreen</code>.
   Fullscreen(Instance* instance);
+
+  /// Destructor.
   virtual ~Fullscreen();
 
-  // PPB_Fullscreen methods.
+  /// IsFullscreen() checks whether the module instance is currently in
+  /// fullscreen mode.
+  ///
+  /// @return <code>true</code> if the module instance is in fullscreen mode,
+  ///<code>false</code> if the module instance is not in fullscreen mode.
   bool IsFullscreen();
+
+  /// SetFullscreen() switches the module instance to and from fullscreen
+  /// mode.
+  ///
+  /// The transition to and from fullscreen mode is asynchronous. During the
+  /// transition, IsFullscreen() will return the previous value and
+  /// no 2D or 3D device can be bound. The transition ends at DidChangeView()
+  /// when IsFullscreen() returns the new value. You might receive other
+  /// DidChangeView() calls while in transition.
+  ///
+  /// The transition to fullscreen mode can only occur while the browser is
+  /// processing a user gesture, even if <code>true</code> is returned.
+  ///
+  /// @param[in] fullscreen <code>true</code> to enter fullscreen mode, or
+  /// <code>false</code> to exit fullscreen mode.
+  ///
+  ///@return <code>true</code> on success or <code>false</code> on
+  /// failure.
   bool SetFullscreen(bool fullscreen);
+
+  /// GetScreenSize() gets the size of the screen in pixels. The module instance
+  /// will be resized to this size when SetFullscreen() is called to enter
+  /// fullscreen mode.
+  ///
+  /// @param[out] size The size of the entire screen in pixels.
+  ///
+  /// @return <code>true</code> on success or <code>false</code> on
+  /// failure.
   bool GetScreenSize(Size* size);
 
  private:
-- 
cgit v1.1