Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(115)

Unified Diff: ppapi/cpp/common.h

Issue 7054060: New documentation for resource.h, core.h, and common.h (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src/
Patch Set: '' Created 9 years, 6 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « no previous file | ppapi/cpp/core.h » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: ppapi/cpp/common.h
===================================================================
--- ppapi/cpp/common.h (revision 88337)
+++ ppapi/cpp/common.h (working copy)
@@ -1,38 +1,35 @@
-// Copyright (c) 2010 The Chromium Authors. All rights reserved.
+// Copyright (c) 2011 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_COMMON_H_
#define PPAPI_CPP_COMMON_H_
-/**
- * @file
- * Defines the API ...
- *
- * @addtogroup CPP
- * @{
- */
+/// @file
+/// Defines the API to convert PP_Bool to and from their C++ equivalent.
+
#include "ppapi/c/pp_bool.h"
namespace pp {
-/** Convert a C++ bool to the appropriate PP_Bool value. */
+/// This function is used to convert a C++ bool to the appropriate PP_Bool
+/// value.
+/// @param[in] value A C++ boolean value.
+/// @return A PP_Bool equivalent of the C++ boolean value.
inline PP_Bool BoolToPPBool(bool value) {
return value ? PP_TRUE : PP_FALSE;
}
-/** Convert a PP_Bool to a C++ bool value. */
+/// This function is used to convert a PP_Bool to a C++ boolean value.
+/// value.
+/// @param[in] value A PP_Bool boolean value.
+/// @return A C++ equivalent of the PP_Bool boolean value.
inline bool PPBoolToBool(PP_Bool value) {
return !!value;
}
} // namespace pp
-/**
- * @}
- * End addtogroup CPP
- */
-
#endif // PPAPI_CPP_COMMON_H_
« no previous file with comments | « no previous file | ppapi/cpp/core.h » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698