Minor changes as per Christians most-recent review of the docs.

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

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

10 files changed, 24 insertions, 21 deletions

diff --git a/ppapi/api/pp_input_event.idl b/ppapi/api/pp_input_event.idl
index f9dc737..41ea0be 100644
--- a/ppapi/api/pp_input_event.idl
+++ b/ppapi/api/pp_input_event.idl
@@ -67,7 +67,7 @@ struct PP_InputEvent_Character {
    * This value represents the typed character as a single null-terminated UTF-8
    * character. Any unused bytes will be filled with null bytes. Since the
    * maximum UTF-8 character is 4 bytes, there will always be at least one null
-   * at the end so you can treat this as a null-termianted UTF-8 string.
+   * at the end so you can treat this as a null-terminated UTF-8 string.
    */
   char[5] text;
 };
diff --git a/ppapi/api/ppb_audio_config.idl b/ppapi/api/ppb_audio_config.idl
index 2954e6e..4c2e3a2 100644
--- a/ppapi/api/ppb_audio_config.idl
+++ b/ppapi/api/ppb_audio_config.idl
@@ -41,7 +41,7 @@ enum PP_AudioSampleRate {
 /**
  * The <code>PPB_AudioConfig</code> interface contains pointers to several
  * functions for establishing your audio configuration within the browser.
- * This interface only supports stereo * 16bit output.
+ * This interface only supports 16-bit stereo output.
  *
  * Refer to the
  * <a href="/chrome/nativeclient/docs/audio.html">Pepper
@@ -73,7 +73,7 @@ interface PPB_AudioConfig {
    *
    * @param[in] instance A <code>PP_Instance</code> identifying one instance
    * of a module.
-   * @param[in] sample_rate A P<code>P_AudioSampleRate</code> which is either
+   * @param[in] sample_rate A <code>PP_AudioSampleRate</code> which is either
    * <code>PP_AUDIOSAMPLERATE_44100</code> or
    * <code>PP_AUDIOSAMPLERATE_48000</code>.
    * @param[in] sample_frame_count A <code>uint32_t</code> frame count returned
diff --git a/ppapi/api/ppb_file_system.idl b/ppapi/api/ppb_file_system.idl
index 45b4805..20d43bf 100644
--- a/ppapi/api/ppb_file_system.idl
+++ b/ppapi/api/ppb_file_system.idl
@@ -51,10 +51,12 @@ interface PPB_FileSystem {
    * completion of Open().
    *
    * @return An int32_t containing an error code from <code>pp_errors.h</code>.
-   *
-   * TODO(brettw) clarify whether this must have completed before a file can
-   * be opened in it. Clarify what it means to be "completed."
    */
+  
+   /* 
+    * TODO(brettw) clarify whether this must have completed before a file can
+    * be opened in it. Clarify what it means to be "completed."
+    */
   int32_t Open([in] PP_Resource file_system,
                [in] int64_t expected_size,
                [in] PP_CompletionCallback callback);
diff --git a/ppapi/c/pp_input_event.h b/ppapi/c/pp_input_event.h
index ce81b90..189f517 100644
--- a/ppapi/c/pp_input_event.h
+++ b/ppapi/c/pp_input_event.h
@@ -3,7 +3,7 @@
  * found in the LICENSE file.
  */
 
-/* From pp_input_event.idl modified Wed Oct  5 14:06:02 2011. */
+/* From pp_input_event.idl modified Fri Jan 20 13:08:22 2012. */
 
 #ifndef PPAPI_C_PP_INPUT_EVENT_H_
 #define PPAPI_C_PP_INPUT_EVENT_H_
@@ -79,7 +79,7 @@ struct PP_InputEvent_Character {
    * This value represents the typed character as a single null-terminated UTF-8
    * character. Any unused bytes will be filled with null bytes. Since the
    * maximum UTF-8 character is 4 bytes, there will always be at least one null
-   * at the end so you can treat this as a null-termianted UTF-8 string.
+   * at the end so you can treat this as a null-terminated UTF-8 string.
    */
   char text[5];
 };
diff --git a/ppapi/c/ppb_audio_config.h b/ppapi/c/ppb_audio_config.h
index 777eed4..2b62c3d 100644
--- a/ppapi/c/ppb_audio_config.h
+++ b/ppapi/c/ppb_audio_config.h
@@ -3,7 +3,7 @@
  * found in the LICENSE file.
  */
 
-/* From ppb_audio_config.idl modified Wed Oct  5 14:06:02 2011. */
+/* From ppb_audio_config.idl modified Fri Jan 20 13:12:44 2012. */
 
 #ifndef PPAPI_C_PPB_AUDIO_CONFIG_H_
 #define PPAPI_C_PPB_AUDIO_CONFIG_H_
@@ -62,7 +62,7 @@ PP_COMPILE_ASSERT_SIZE_IN_BYTES(PP_AudioSampleRate, 4);
 /**
  * The <code>PPB_AudioConfig</code> interface contains pointers to several
  * functions for establishing your audio configuration within the browser.
- * This interface only supports stereo * 16bit output.
+ * This interface only supports 16-bit stereo output.
  *
  * Refer to the
  * <a href="/chrome/nativeclient/docs/audio.html">Pepper
@@ -93,7 +93,7 @@ struct PPB_AudioConfig_1_0 {
    *
    * @param[in] instance A <code>PP_Instance</code> identifying one instance
    * of a module.
-   * @param[in] sample_rate A P<code>P_AudioSampleRate</code> which is either
+   * @param[in] sample_rate A <code>PP_AudioSampleRate</code> which is either
    * <code>PP_AUDIOSAMPLERATE_44100</code> or
    * <code>PP_AUDIOSAMPLERATE_48000</code>.
    * @param[in] sample_frame_count A <code>uint32_t</code> frame count returned
diff --git a/ppapi/c/ppb_file_system.h b/ppapi/c/ppb_file_system.h
index 2f2c919..a018538 100644
--- a/ppapi/c/ppb_file_system.h
+++ b/ppapi/c/ppb_file_system.h
@@ -3,7 +3,7 @@
  * found in the LICENSE file.
  */
 
-/* From ppb_file_system.idl modified Wed Oct  5 14:06:02 2011. */
+/* From ppb_file_system.idl modified Wed Feb 15 13:55:58 2012. */
 
 #ifndef PPAPI_C_PPB_FILE_SYSTEM_H_
 #define PPAPI_C_PPB_FILE_SYSTEM_H_
@@ -67,7 +67,8 @@ struct PPB_FileSystem_1_0 {
    * completion of Open().
    *
    * @return An int32_t containing an error code from <code>pp_errors.h</code>.
-   *
+   */
+  /*
    * TODO(brettw) clarify whether this must have completed before a file can
    * be opened in it. Clarify what it means to be "completed."
    */
diff --git a/ppapi/cpp/audio.h b/ppapi/cpp/audio.h
index e42a8e3..8df9f37d 100644
--- a/ppapi/cpp/audio.h
+++ b/ppapi/cpp/audio.h
@@ -1,4 +1,4 @@
-// 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.
 
@@ -18,8 +18,8 @@
 namespace pp {
 
 /// An audio resource. Refer to the
-/// <a href="/chrome/nativeclient/docs/audio.html">Pepper
-/// Audio API Code Walkthrough</a> for information on using this interface.
+/// <a href="/native-client/devguide/coding/audio">Audio</a>
+/// chapter in the Developer's Guide for information on using this interface.
 class Audio : public Resource {
  public:
 
diff --git a/ppapi/cpp/input_event.h b/ppapi/cpp/input_event.h
index 11ca96e..39e8cf3 100644
--- a/ppapi/cpp/input_event.h
+++ b/ppapi/cpp/input_event.h
@@ -121,7 +121,7 @@ class MouseInputEvent : public InputEvent {
   /// position of the mouse when the eent occurred.
   ///
   /// @param[in] click_count
-  /// TODO(brettw) figure out exactly what this means.
+  // TODO(brettw) figure out exactly what this means.
   ///
   /// @param[in] mouse_movement The change in position of the mouse.
   MouseInputEvent(Instance* instance,
diff --git a/ppapi/cpp/instance.h b/ppapi/cpp/instance.h
index 9927624..025f398 100644
--- a/ppapi/cpp/instance.h
+++ b/ppapi/cpp/instance.h
@@ -457,7 +457,7 @@ class Instance {
   /// @}
 
   /// AddPerInstanceObject() associates an instance with an interface,
-  /// creating an object... {PENDING: clarify!}
+  /// creating an object.
   ///
   /// Many optional interfaces are associated with a plugin instance. For
   /// example, the find in PPP_Find interface receives updates on a per-instance
@@ -486,7 +486,7 @@ class Instance {
   /// @param[in] object
   void AddPerInstanceObject(const std::string& interface_name, void* object);
 
-  /// {PENDING: summarize Remove method here}
+  // {PENDING: summarize Remove method here}
   ///
   /// Refer to AddPerInstanceObject() for further information.
   ///
diff --git a/ppapi/cpp/var.h b/ppapi/cpp/var.h
index 56c479f3..a0c5c19 100644
--- a/ppapi/cpp/var.h
+++ b/ppapi/cpp/var.h
@@ -68,8 +68,8 @@ class Var {
 
   struct DontManage {};
 
-  /// TODO(brettw): remove DontManage when this bug is fixed
-  ///              http://code.google.com/p/chromium/issues/detail?id=52105
+  // TODO(brettw): remove DontManage when this bug is fixed
+  //               http://code.google.com/p/chromium/issues/detail?id=52105
   /// This constructor is used when we've given a <code>PP_Var</code> as an
   /// input argument from somewhere and that reference is managing the
   /// reference count for us. The object will not have its reference count