summaryrefslogtreecommitdiffstats
path: root/ppapi/api/ppb_audio_config.idl
diff options
context:
space:
mode:
authorjond@google.com <jond@google.com@0039d316-1c4b-4281-b951-d872f2087c98>2011-08-30 19:10:40 +0000
committerjond@google.com <jond@google.com@0039d316-1c4b-4281-b951-d872f2087c98>2011-08-30 19:10:40 +0000
commit216326c656dff569a10195ab91edecf8f43a33b1 (patch)
tree12f87f5be2cfb9cb861b7526be3d8e923036eca0 /ppapi/api/ppb_audio_config.idl
parent5ce7b1d9688559ebf02023a067399b1a7c78181a (diff)
downloadchromium_src-216326c656dff569a10195ab91edecf8f43a33b1.zip
chromium_src-216326c656dff569a10195ab91edecf8f43a33b1.tar.gz
chromium_src-216326c656dff569a10195ab91edecf8f43a33b1.tar.bz2
Changed all @code to <code> and @endcode to </code> as per dmichael. Adding Polina to the review to look at url_loader.h and give approval of text that points to example.
Review URL: http://codereview.chromium.org/7715005 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@98856 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'ppapi/api/ppb_audio_config.idl')
-rw-r--r--ppapi/api/ppb_audio_config.idl23
1 files changed, 14 insertions, 9 deletions
diff --git a/ppapi/api/ppb_audio_config.idl b/ppapi/api/ppb_audio_config.idl
index 895373b..b798e38 100644
--- a/ppapi/api/ppb_audio_config.idl
+++ b/ppapi/api/ppb_audio_config.idl
@@ -71,13 +71,14 @@ interface PPB_AudioConfig {
* right channel sample.
* Data will always be in the native endian format of the platform.
*
- * @param[in] instance A <code>PP_Instance indentifying</code> one instance
+ * @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
* <code>PP_AUDIOSAMPLERATE_44100</code> or
* <code>PP_AUDIOSAMPLERATE_48000</code>.
* @param[in] sample_frame_count A <code>uint32_t</code> frame count returned
* from the <code>RecommendSampleFrameCount</code> function.
+ *
* @return A <code>PP_Resource</code> containing the
* <code>PPB_Audio_Config</code> if successful or a null resource if the
* sample frame count or bit rate are not supported.
@@ -106,6 +107,7 @@ interface PPB_AudioConfig {
* <code>PP_AUDIOSAMPLERATE_48000.</code>
* @param[in] requested_sample_frame_count A <code>uint_32t</code> requested
* frame count.
+ *
* @return A <code>uint32_t</code> containing the recommended sample frame
* count if successful.
*/
@@ -117,9 +119,10 @@ interface PPB_AudioConfig {
* IsAudioConfig() determines if the given resource is a
* <code>PPB_Audio_Config</code>.
*
- * @param[in] resource A <code>PP_Resource</code> containing the audio config
- * resource.
- * @return A <code>PP_BOOL</code> containing <code>PP_TRUE</code> if the given
+ * @param[in] resource A <code>PP_Resource</code> corresponding to an audio
+ * config resource.
+ *
+ * @return A <code>PP_Bool</code> containing <code>PP_TRUE</code> if the given
* resource is an <code>AudioConfig</code> resource, otherwise
* <code>PP_FALSE</code>.
*/
@@ -130,8 +133,9 @@ interface PPB_AudioConfig {
* GetSampleRate() returns the sample rate for the given
* <code>PPB_Audio_Config</code>.
*
- * @param[in] config A <code>PP_Resource</code> containing the
+ * @param[in] config A <code>PP_Resource</code> corresponding to a
* <code>PPB_Audio_Config</code>.
+ *
* @return A <code>PP_AudioSampleRate</code> containing sample rate or
* <code>PP_AUDIOSAMPLERATE_NONE</code> if the resource is invalid.
*/
@@ -142,11 +146,12 @@ interface PPB_AudioConfig {
* GetSampleFrameCount() returns the sample frame count for the given
* <code>PPB_Audio_Config</code>.
*
- * @param[in] config A <code>PP_Resource</code> containing the audio config
- * resource.
+ * @param[in] config A <code>PP_Resource</code> corresponding to an audio
+ * config resource.
+ *
* @return A <code>uint32_t</code> containing sample frame count or
- * 0 if the resource is invalid. See <code>RecommendSampleFrameCount</code>
- * for more on sample frame counts.
+ * 0 if the resource is invalid. Refer to
+ * RecommendSampleFrameCount() for more on sample frame counts.
*/
uint32_t GetSampleFrameCount(
[in] PP_Resource config);