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

Side by Side Diff: ppapi/cpp/module.h

Issue 9600025: Fixed some TODO comments so they wouldn't show up in the docs. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src/
Patch Set: Created 8 years, 9 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 unified diff | Download patch | Annotate | Revision Log
« no previous file with comments | « ppapi/c/ppb_input_event.h ('k') | no next file » | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 // Copyright (c) 2011 The Chromium Authors. All rights reserved. 1 // Copyright (c) 2011 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be 2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file. 3 // found in the LICENSE file.
4 4
5 #ifndef PPAPI_CPP_MODULE_H_ 5 #ifndef PPAPI_CPP_MODULE_H_
6 #define PPAPI_CPP_MODULE_H_ 6 #define PPAPI_CPP_MODULE_H_
7 7
8 #include <map> 8 #include <map>
9 #include <string> 9 #include <string>
10 10
(...skipping 38 matching lines...) Expand 10 before | Expand all | Expand 10 after
49 /// @return true if successful, otherwise false. 49 /// @return true if successful, otherwise false.
50 virtual bool Init(); 50 virtual bool Init();
51 51
52 /// The pp_module() function returns the internal module handle. 52 /// The pp_module() function returns the internal module handle.
53 /// 53 ///
54 /// @return A <code>PP_Module</code> internal module handle. 54 /// @return A <code>PP_Module</code> internal module handle.
55 PP_Module pp_module() const { return pp_module_; } 55 PP_Module pp_module() const { return pp_module_; }
56 56
57 /// The get_browser_interface() function returns the internal 57 /// The get_browser_interface() function returns the internal
58 /// <code>get_browser_interface</code> pointer. 58 /// <code>get_browser_interface</code> pointer.
59 /// TODO(sehr): This should be removed once the NaCl browser plugin no longer
60 /// needs it.
61 /// 59 ///
62 /// @return A <code>PPB_GetInterface</code> internal pointer. 60 /// @return A <code>PPB_GetInterface</code> internal pointer.
61 // TODO(sehr): This should be removed once the NaCl browser plugin no longer
62 // needs it.
63 PPB_GetInterface get_browser_interface() const { 63 PPB_GetInterface get_browser_interface() const {
64 return get_browser_interface_; 64 return get_browser_interface_;
65 } 65 }
66 66
67 /// The core() function returns the core interface for doing basic 67 /// The core() function returns the core interface for doing basic
68 /// global operations. The return value is guaranteed to be non-NULL once the 68 /// global operations. The return value is guaranteed to be non-NULL once the
69 /// module has successfully initialized and during the Init() call. 69 /// module has successfully initialized and during the Init() call.
70 /// 70 ///
71 /// It will be NULL before Init() has been called. 71 /// It will be NULL before Init() has been called.
72 /// 72 ///
(...skipping 40 matching lines...) Expand 10 before | Expand all | Expand 10 after
113 /// 113 ///
114 /// @param[in] interface_name The interface name that will receive a handler. 114 /// @param[in] interface_name The interface name that will receive a handler.
115 /// @param[in,out] vtable The vtable to return for 115 /// @param[in,out] vtable The vtable to return for
116 /// <code>interface_name</code>. 116 /// <code>interface_name</code>.
117 void AddPluginInterface(const std::string& interface_name, 117 void AddPluginInterface(const std::string& interface_name,
118 const void* vtable); 118 const void* vtable);
119 119
120 // InternalInit() sets the browser interface and calls the regular Init() 120 // InternalInit() sets the browser interface and calls the regular Init()
121 /// function that can be overridden by the base classes. 121 /// function that can be overridden by the base classes.
122 /// 122 ///
123 /// TODO(brettw) make this private when I can figure out how to make the
124 /// initialize function a friend.
125 ///
126 /// @param[in] mod A <code>PP_Module</code>. 123 /// @param[in] mod A <code>PP_Module</code>.
127 /// @param[in] get_browser_interface The browser interface to set. 124 /// @param[in] get_browser_interface The browser interface to set.
128 /// 125 ///
129 /// @return true if successful, otherwise false. 126 /// @return true if successful, otherwise false.
127 // TODO(brettw) make this private when I can figure out how to make the
128 // initialize function a friend.
130 bool InternalInit(PP_Module mod, 129 bool InternalInit(PP_Module mod,
131 PPB_GetInterface get_browser_interface); 130 PPB_GetInterface get_browser_interface);
132 131
133 /// The current_instances() function allows iteration over the 132 /// The current_instances() function allows iteration over the
134 /// current instances in the module. 133 /// current instances in the module.
135 /// 134 ///
136 /// @return An <code>InstanceMap</code> of all instances in the module. 135 /// @return An <code>InstanceMap</code> of all instances in the module.
137 const InstanceMap& current_instances() const { return current_instances_; } 136 const InstanceMap& current_instances() const { return current_instances_; }
138 137
139 protected: 138 protected:
(...skipping 25 matching lines...) Expand all
165 164
166 // All additional interfaces this plugin can handle as registered by 165 // All additional interfaces this plugin can handle as registered by
167 // AddPluginInterface. 166 // AddPluginInterface.
168 typedef std::map<std::string, const void*> InterfaceMap; 167 typedef std::map<std::string, const void*> InterfaceMap;
169 InterfaceMap additional_interfaces_; 168 InterfaceMap additional_interfaces_;
170 }; 169 };
171 170
172 } // namespace pp 171 } // namespace pp
173 172
174 #endif // PPAPI_CPP_MODULE_H_ 173 #endif // PPAPI_CPP_MODULE_H_
OLDNEW
« no previous file with comments | « ppapi/c/ppb_input_event.h ('k') | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698