New C++ Docs.

ppapi/cpp/module_embedder.h

Index: ppapi/cpp/module_embedder.h
===================================================================
--- ppapi/cpp/module_embedder.h	(revision 95101)
+++ ppapi/cpp/module_embedder.h	(working copy)
@@ -1,18 +1,24 @@
-// 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_MODULE_EMBEDDER_H_
 #define PPAPI_CPP_MODULE_EMBEDDER_H_
 
+/// @file
+/// This file defines the APIs for creating a Module object.
 namespace pp {
 
+/// A Module object associated with this module.

[dmichael (off chromium), 2011/08/03 15:50:49]

Just remove this comment.

[jond, 2011/08/04 19:55:20]

Done.

 class Module;

[dmichael (off chromium), 2011/08/03 15:50:49]

Please add a carriage return here.

[jond, 2011/08/03 20:15:08]

Done.

[jond, 2011/08/04 19:55:20]

Done.

-// Implemented by the embedder.
-//
-// Creates the pp::Module object associated with this plugin. Returns the
-// module if it was successfully created, or NULL on failure. Upon failure,
-// the plugin will be unloaded.
+/// This function creates the <code>pp::Module</code> object associated with
+/// this module.
+///
+/// @return Returns the module if it was successfully created, or NULL on
+/// failure. Upon failure, the module will be unloaded.
+///
+// <strong>Note:</code> This method documentation had "implemented by the
+// embedder" at the top. not sure what that means.

[dmichael (off chromium), 2011/08/03 15:50:49]

It means that the developer of the plugin/NaCl module needs to implement this
method.

See the last bit of hello_world.cc in the SDK for an example.

[jond, 2011/08/03 20:15:08]

So, do I need this note or will people learn this from hello_world.cc? I put a
new note in.

On 2011/08/03 15:50:49, dmichael wrote:

[dmichael (off chromium), 2011/08/04 16:33:38]

Yes, the API needs to be documented here. The examples give sort of a tour
through the API, but the ppapi code has to serve as the reference.

[jond, 2011/08/04 19:55:20]

Done.

[jond, 2011/08/04 19:55:20]

Done.

 pp::Module* CreateModule();
 
 }  // namespace pp