Formatting changes.

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

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@91595 0039d316-1c4b-4281-b951-d872f2087c98

1 files changed, 36 insertions, 31 deletions

diff --git a/ppapi/cpp/core.h b/ppapi/cpp/core.h
index e6a0853..45a90c3 100644
--- a/ppapi/cpp/core.h
+++ b/ppapi/cpp/core.h
@@ -23,92 +23,97 @@ class Core {
   // be called only when doing manual management on raw PP_Resource handles,
   // which should be fairly rare.
 
-  /// A function that increments the reference count for the provided resource.
+  /// AddRefResource() increments the reference count for the provided
+  /// <code>resource</code>.
   ///
-  /// @param[in] resource A PP_Resource containing the resource.
+  /// @param[in] resource A <code>PP_Resource</code> containing the resource.
   void AddRefResource(PP_Resource resource) {
     interface_->AddRefResource(resource);
   }
 
-  /// A function that decrements the reference count for the provided resource.
-  /// The resource will be deallocated if the reference count reaches zero.
+  /// ReleaseResource() decrements the reference count for the provided
+  /// <code>resource</code>. The resource will be deallocated if the
+  /// reference count reaches zero.
   ///
-  /// @param[in] resource A PP_Resource containing the resource.
+  /// @param[in] resource A <code>PP_Resource</code> containing the resource.
   void ReleaseResource(PP_Resource resource) {
     interface_->ReleaseResource(resource);
   }
 
-  /// A function that allocates memory.
+  /// MemAlloc() allocates memory.
   ///
   /// @param[in] num_bytes A number of bytes to allocate.
-  /// @return A pointer to the memory if successful, NULL If the
+  ///
+  /// @return A pointer to the memory if successful, <code>NULL</code> If the
   /// allocation fails.
   void* MemAlloc(uint32_t num_bytes) {
     return interface_->MemAlloc(num_bytes);
   }
 
-  /// A function that deallocates memory.
+  /// MemFree() deallocates memory.
   ///
   /// @param[in] ptr A pointer to the memory to deallocate. It is safe to
-  /// pass NULL to this function.
+  /// pass <code>NULL</code> to this function.
   void MemFree(void* ptr) {
     interface_->MemFree(ptr);
   }
 
-  /// A function that that returns the "wall clock time" according to the
+  /// GetTime() returns the "wall clock time" according to the
   /// browser.
   ///
-  /// @return A PP_Time containing the "wall clock time" according to the
-  /// browser.
+  /// @return A <code>PP_Time</code> containing the "wall clock time" according
+  /// to the browser.
   PP_Time GetTime() {
     return interface_->GetTime();
   }
 
-  /// A function that that returns the "tick time" according to the browser.
+  /// GetTimeTicks() returns the "tick time" according to the browser.
   /// This clock is used by the browser when passing some event times to the
-  /// plugin (e.g., via the PP_InputEvent::time_stamp_seconds field). It is
-  /// not correlated to any actual wall clock time (like GetTime()). Because
+  /// plugin (for example, using the
+  /// <code>PP_InputEvent::time_stamp_seconds</code> field). It is not
+  /// correlated to any actual wall clock time (like GetTime()). Because
   /// of this, it will not change if the user changes their computer clock.
   ///
-  /// @return A PP_TimeTicks containing the "tick time" according to the
-  /// browser.
+  /// @return A <code>PP_TimeTicks</code> containing the "tick time" according
+  /// to the browser.
   PP_TimeTicks GetTimeTicks() {
     return interface_->GetTimeTicks();
   }
 
-  /// A function that schedules work to be executed on the main pepper thread
-  /// after the specified delay. The delay may be 0 to specify a call back as
-  /// soon as possible.
+  /// CallOnMainThread() schedules work to be executed on the main pepper
+  /// thread after the specified delay. The delay may be 0 to specify a call
+  /// back as soon as possible.
   ///
   /// The |result| parameter will just be passed as the second argument to the
   /// callback. Many applications won't need this, but it allows a plugin to
   /// emulate calls of some callbacks which do use this value.
   ///
-  /// NOTE: CallOnMainThread, even when used from the main thread with a delay
-  /// of 0 milliseconds, will never directly invoke the callback.  Even in this
-  /// case, the callback will be scheduled asynchronously.
+  /// <strong>Note:</strong> CallOnMainThread(), even when used from the main
+  /// thread with a delay of 0 milliseconds, will never directly invoke the
+  /// callback.  Even in this case, the callback will be scheduled
+  /// asynchronously.
   ///
-  /// NOTE: If the browser is shutting down or if the plugin has no instances,
-  /// then the callback function may not be called.
+  /// <strong>Note:</strong> If the browser is shutting down or if the module
+  /// has no instances, then the callback function may not be called.
   ///
   /// @param[in] delay_in_milliseconds An int32_t delay in milliseconds.
-  /// @param[in] callback A CompletionCallback callback function that the
-  /// browser will call after the specified delay.
+  /// @param[in] callback A <code>CompletionCallback</code> callback function
+  /// that the browser will call after the specified delay.
   /// @param[in] result An int32_t that the browser will pass to the given
-  /// CompletionCallback.
+  /// <code>CompletionCallback</code>.
   void CallOnMainThread(int32_t delay_in_milliseconds,
                         const CompletionCallback& callback,
                         int32_t result = 0);
 
 
-  /// A function that returns true if the current thread is the main pepper
+  /// IsMainThread() returns true if the current thread is the main pepper
   /// thread.
   ///
   /// This function is useful for implementing sanity checks, and deciding if
   /// dispatching using CallOnMainThread() is required.
   ///
-  /// @return A PP_BOOL containing PP_TRUE if the current thread is the main
-  /// pepper thread, otherwise PP_FALSE.
+  /// @return A bool containing true if the current thread is
+  /// the main pepper thread, otherwise false.
   bool IsMainThread();
 
  private: