diff options
author | jond@google.com <jond@google.com@0039d316-1c4b-4281-b951-d872f2087c98> | 2012-04-26 22:00:05 +0000 |
---|---|---|
committer | jond@google.com <jond@google.com@0039d316-1c4b-4281-b951-d872f2087c98> | 2012-04-26 22:00:05 +0000 |
commit | 7b8fd35ead1d0bd04ed3ad2be7a47133169765c8 (patch) | |
tree | 8eeba851dc0ddf66e484934847512571e88bb488 /ppapi | |
parent | d84d79bbc2777f43b11c32ef8912cc451b5a086b (diff) | |
download | chromium_src-7b8fd35ead1d0bd04ed3ad2be7a47133169765c8.zip chromium_src-7b8fd35ead1d0bd04ed3ad2be7a47133169765c8.tar.gz chromium_src-7b8fd35ead1d0bd04ed3ad2be7a47133169765c8.tar.bz2 |
Inserted missing documentation for parameters. Also fixed a confusing sentence in audio_config.h.
Review URL: http://codereview.chromium.org/10069017
git-svn-id: svn://svn.chromium.org/chrome/trunk/src@134159 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'ppapi')
-rw-r--r-- | ppapi/cpp/audio_config.h | 6 | ||||
-rw-r--r-- | ppapi/cpp/completion_callback.h | 4 |
2 files changed, 7 insertions, 3 deletions
diff --git a/ppapi/cpp/audio_config.h b/ppapi/cpp/audio_config.h index 46eda9d..3b1cefd 100644 --- a/ppapi/cpp/audio_config.h +++ b/ppapi/cpp/audio_config.h @@ -65,8 +65,7 @@ class AudioConfig : public Resource { /// resulting resource will be is_null(). You can pass the result of /// RecommendSampleFrameCount() as the sample frame count. /// - /// @param[in] instance The instance with which this resource will be - /// associated. + /// @param[in] instance The instance associated with this resource. /// /// @param[in] sample_rate A <code>PP_AudioSampleRate</code> which is either /// <code>PP_AUDIOSAMPLERATE_44100</code> or @@ -81,6 +80,8 @@ class AudioConfig : public Resource { /// RecommendSampleRate() returns the native sample rate used by the /// audio system. Applications that use the recommended sample rate might /// obtain lower latency and higher fidelity output. + /// + /// @param[in] instance The instance associated with this resource. static PP_AudioSampleRate RecommendSampleRate( const InstanceHandle& instance); @@ -96,6 +97,7 @@ class AudioConfig : public Resource { /// will return a supported count closest to the requested value for use in /// the constructor. /// + /// @param[in] instance The instance associated with this resource. /// @param[in] sample_rate A <code>PP_AudioSampleRate</code> which is either /// <code>PP_AUDIOSAMPLERATE_44100</code> or /// <code>PP_AUDIOSAMPLERATE_48000</code>. diff --git a/ppapi/cpp/completion_callback.h b/ppapi/cpp/completion_callback.h index 3d142e8..9539dfc 100644 --- a/ppapi/cpp/completion_callback.h +++ b/ppapi/cpp/completion_callback.h @@ -205,10 +205,10 @@ class CompletionCallbackWithOutput : public CompletionCallback { /// A constructor for creating a <code>CompletionCallback</code> that /// references the given output data. /// + /// @param[in] func The function to be called on completion. /// @param[in] user_data The user data to be passed to the callback function. /// This is optional and is typically used to help track state in case of /// multiple pending callbacks. - /// /// @param[in] output A pointer to the data associated with the callback. The /// caller must ensure that this pointer outlives the completion callback. CompletionCallbackWithOutput(PP_CompletionCallback_Func func, @@ -221,6 +221,8 @@ class CompletionCallbackWithOutput : public CompletionCallback { /// A constructor for creating a <code>CompletionCallback</code> that /// references the given output data. /// + /// @param[in] func The function to be called on completion. + /// /// @param[in] user_data The user data to be passed to the callback function. /// This is optional and is typically used to help track state in case of /// multiple pending callbacks. |