Skip to content

GitLab

T
tangled
Commit ca9bc12c authored by jond@google.com's avatar jond@google.com
Browse files
Options

Changed <code> to @code and </code> to @endcode (for formatting issues.... 

Changed <code> to @code and </code> to @endcode (for formatting issues. Removed .html (extensions not needed for DevSite) as per Andy.

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

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@124788 0039d316-1c4b-4281-b951-d872f2087c98
parent 6b1af1fe
Hide whitespace changes
Inline Side-by-side
Showing with 34 additions and 35 deletions
ppapi/api/ppb.idl
View file @ ca9bc12c
...@@ -19,7 +19,7 @@ ...@@ -19,7 +19,7 @@
* <code>ppb.audio.h</code> or * <code>ppb.audio.h</code> or
* <code>PPB_GRAPHICS_2D_INTERFACE</code> in <code>ppb_graphics_2d.h</code>. * <code>PPB_GRAPHICS_2D_INTERFACE</code> in <code>ppb_graphics_2d.h</code>.
* Click * Click
* <a href="/chrome/nativeclient/docs/reference/pepperc/globals_defs.html" * <a href="/native-client/{{pepperversion}}/pepperc/globals_defs"
* title="macros">here</a> for a complete list of interface * title="macros">here</a> for a complete list of interface
* names. * names.
* *
......
ppapi/api/ppb_audio.idl
View file @ ca9bc12c
...@@ -25,7 +25,7 @@ typedef void PPB_Audio_Callback([out] mem_t sample_buffer, ...@@ -25,7 +25,7 @@ typedef void PPB_Audio_Callback([out] mem_t sample_buffer,
/** /**
* The <code>PPB_Audio</code> interface contains pointers to several functions * The <code>PPB_Audio</code> interface contains pointers to several functions
* for handling audio resources. Please refer to the * for handling audio resources. Please refer to the
* <a href="/chrome/nativeclient/docs/audio.html">Pepper * <a href="/native-client/{{pepperversion}}/devguide/coding/audio">Pepper
* Audio API</a> for information on using this interface. * Audio API</a> for information on using this interface.
* Please see descriptions for each <code>PPB_Audio</code> and * Please see descriptions for each <code>PPB_Audio</code> and
* <code>PPB_AudioConfig</code> function for more details. A C example using * <code>PPB_AudioConfig</code> function for more details. A C example using
...@@ -33,7 +33,7 @@ typedef void PPB_Audio_Callback([out] mem_t sample_buffer, ...@@ -33,7 +33,7 @@ typedef void PPB_Audio_Callback([out] mem_t sample_buffer,
* *
* <strong>Example: </strong> * <strong>Example: </strong>
* *
* <code> * @code
* void audio_callback(void* sample_buffer, * void audio_callback(void* sample_buffer,
* uint32_t buffer_size_in_bytes, * uint32_t buffer_size_in_bytes,
* void* user_data) { * void* user_data) {
...@@ -41,8 +41,8 @@ typedef void PPB_Audio_Callback([out] mem_t sample_buffer, ...@@ -41,8 +41,8 @@ typedef void PPB_Audio_Callback([out] mem_t sample_buffer,
* } * }
* *
* ...Assume the application has cached the audio configuration interface in * ...Assume the application has cached the audio configuration interface in
* <code>audio_config_interface</code> and the audio interface in * audio_config_interface and the audio interface in
* <code>audio_interface</code>... * audio_interface...
* *
* uint32_t count = audio_config_interface->RecommendSampleFrameCount( * uint32_t count = audio_config_interface->RecommendSampleFrameCount(
* PP_AUDIOSAMPLERATE_44100, 4096); * PP_AUDIOSAMPLERATE_44100, 4096);
...@@ -53,7 +53,7 @@ typedef void PPB_Audio_Callback([out] mem_t sample_buffer, ...@@ -53,7 +53,7 @@ typedef void PPB_Audio_Callback([out] mem_t sample_buffer,
* audio_interface->StartPlayback(pp_audio); * audio_interface->StartPlayback(pp_audio);
* *
* ...audio_callback() will now be periodically invoked on a separate thread... * ...audio_callback() will now be periodically invoked on a separate thread...
* </code> * @endcode
*/ */
interface PPB_Audio { interface PPB_Audio {
/** /**
......
ppapi/api/ppb_messaging.idl
View file @ ca9bc12c
...@@ -44,7 +44,7 @@ interface PPB_Messaging { ...@@ -44,7 +44,7 @@ interface PPB_Messaging {
* *
* <strong>Example:</strong> * <strong>Example:</strong>
* *
* <code> * @code
* *
* <body> * <body>
* <object id="plugin" * <object id="plugin"
...@@ -57,12 +57,11 @@ interface PPB_Messaging { ...@@ -57,12 +57,11 @@ interface PPB_Messaging {
* </script> * </script>
* </body> * </body>
* *
* </code> * @endcode
* *
* The module instance then invokes PostMessage() as follows: * The module instance then invokes PostMessage() as follows:
* *
* <code> * @code
*
* *
* char hello_world[] = "Hello world!"; * char hello_world[] = "Hello world!";
* PP_Var hello_var = ppb_var_interface->VarFromUtf8(instance, * PP_Var hello_var = ppb_var_interface->VarFromUtf8(instance,
...@@ -71,7 +70,7 @@ interface PPB_Messaging { ...@@ -71,7 +70,7 @@ interface PPB_Messaging {
* ppb_messaging_interface->PostMessage(instance, hello_var); // Copies var. * ppb_messaging_interface->PostMessage(instance, hello_var); // Copies var.
* ppb_var_interface->Release(hello_var); * ppb_var_interface->Release(hello_var);
* *
* </code> * @endcode
* *
* The browser will pop-up an alert saying "Hello world!" * The browser will pop-up an alert saying "Hello world!"
*/ */
......
ppapi/api/ppp_messaging.idl
View file @ ca9bc12c
...@@ -39,7 +39,7 @@ interface PPP_Messaging { ...@@ -39,7 +39,7 @@ interface PPP_Messaging {
* *
* <strong>Example:</strong> * <strong>Example:</strong>
* *
* <code> * @code
* *
* <body> * <body>
* <object id="plugin" * <object id="plugin"
...@@ -49,7 +49,7 @@ interface PPP_Messaging { ...@@ -49,7 +49,7 @@ interface PPP_Messaging {
* </script> * </script>
* </body> * </body>
* *
* </code> * @endcode
* *
*/ */
void HandleMessage([in] PP_Instance instance, [in] PP_Var message); void HandleMessage([in] PP_Instance instance, [in] PP_Var message);
......
ppapi/c/ppb.h
View file @ ca9bc12c
/* 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 * Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file. * found in the LICENSE file.
*/ */
/* From ppb.idl modified Fri Aug 12 10:40:59 2011. */ /* From ppb.idl modified Thu Mar 1 14:49:34 2012. */
#ifndef PPAPI_C_PPB_H_ #ifndef PPAPI_C_PPB_H_
#define PPAPI_C_PPB_H_ #define PPAPI_C_PPB_H_
...@@ -33,7 +33,7 @@ ...@@ -33,7 +33,7 @@
* <code>ppb.audio.h</code> or * <code>ppb.audio.h</code> or
* <code>PPB_GRAPHICS_2D_INTERFACE</code> in <code>ppb_graphics_2d.h</code>. * <code>PPB_GRAPHICS_2D_INTERFACE</code> in <code>ppb_graphics_2d.h</code>.
* Click * Click
* <a href="/chrome/nativeclient/docs/reference/pepperc/globals_defs.html" * <a href="/native-client/{{pepperversion}}/pepperc/globals_defs"
* title="macros">here</a> for a complete list of interface * title="macros">here</a> for a complete list of interface
* names. * names.
* *
......
ppapi/c/ppb_audio.h
View file @ ca9bc12c
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
* found in the LICENSE file. * found in the LICENSE file.
*/ */
/* From ppb_audio.idl modified Wed Oct 5 14:06:02 2011. */ /* From ppb_audio.idl modified Thu Mar 1 14:50:30 2012. */
#ifndef PPAPI_C_PPB_AUDIO_H_ #ifndef PPAPI_C_PPB_AUDIO_H_
#define PPAPI_C_PPB_AUDIO_H_ #define PPAPI_C_PPB_AUDIO_H_
...@@ -48,7 +48,7 @@ typedef void (*PPB_Audio_Callback)(void* sample_buffer, ...@@ -48,7 +48,7 @@ typedef void (*PPB_Audio_Callback)(void* sample_buffer,
/** /**
* The <code>PPB_Audio</code> interface contains pointers to several functions * The <code>PPB_Audio</code> interface contains pointers to several functions
* for handling audio resources. Please refer to the * for handling audio resources. Please refer to the
* <a href="/chrome/nativeclient/docs/audio.html">Pepper * <a href="/native-client/{{pepperversion}}/devguide/coding/audio">Pepper
* Audio API</a> for information on using this interface. * Audio API</a> for information on using this interface.
* Please see descriptions for each <code>PPB_Audio</code> and * Please see descriptions for each <code>PPB_Audio</code> and
* <code>PPB_AudioConfig</code> function for more details. A C example using * <code>PPB_AudioConfig</code> function for more details. A C example using
...@@ -56,7 +56,7 @@ typedef void (*PPB_Audio_Callback)(void* sample_buffer, ...@@ -56,7 +56,7 @@ typedef void (*PPB_Audio_Callback)(void* sample_buffer,
* *
* <strong>Example: </strong> * <strong>Example: </strong>
* *
* <code> * @code
* void audio_callback(void* sample_buffer, * void audio_callback(void* sample_buffer,
* uint32_t buffer_size_in_bytes, * uint32_t buffer_size_in_bytes,
* void* user_data) { * void* user_data) {
...@@ -64,8 +64,8 @@ typedef void (*PPB_Audio_Callback)(void* sample_buffer, ...@@ -64,8 +64,8 @@ typedef void (*PPB_Audio_Callback)(void* sample_buffer,
* } * }
* *
* ...Assume the application has cached the audio configuration interface in * ...Assume the application has cached the audio configuration interface in
* <code>audio_config_interface</code> and the audio interface in * audio_config_interface and the audio interface in
* <code>audio_interface</code>... * audio_interface...
* *
* uint32_t count = audio_config_interface->RecommendSampleFrameCount( * uint32_t count = audio_config_interface->RecommendSampleFrameCount(
* PP_AUDIOSAMPLERATE_44100, 4096); * PP_AUDIOSAMPLERATE_44100, 4096);
...@@ -76,7 +76,7 @@ typedef void (*PPB_Audio_Callback)(void* sample_buffer, ...@@ -76,7 +76,7 @@ typedef void (*PPB_Audio_Callback)(void* sample_buffer,
* audio_interface->StartPlayback(pp_audio); * audio_interface->StartPlayback(pp_audio);
* *
* ...audio_callback() will now be periodically invoked on a separate thread... * ...audio_callback() will now be periodically invoked on a separate thread...
* </code> * @endcode
*/ */
struct PPB_Audio_1_0 { struct PPB_Audio_1_0 {
/** /**
......
ppapi/c/ppb_messaging.h
View file @ ca9bc12c
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
* found in the LICENSE file. * found in the LICENSE file.
*/ */
/* From ppb_messaging.idl modified Wed Oct 5 14:06:02 2011. */ /* From ppb_messaging.idl modified Mon Feb 27 13:31:21 2012. */
#ifndef PPAPI_C_PPB_MESSAGING_H_ #ifndef PPAPI_C_PPB_MESSAGING_H_
#define PPAPI_C_PPB_MESSAGING_H_ #define PPAPI_C_PPB_MESSAGING_H_
...@@ -60,7 +60,7 @@ struct PPB_Messaging_1_0 { ...@@ -60,7 +60,7 @@ struct PPB_Messaging_1_0 {
* *
* <strong>Example:</strong> * <strong>Example:</strong>
* *
* <code> * @code
* *
* <body> * <body>
* <object id="plugin" * <object id="plugin"
...@@ -73,12 +73,11 @@ struct PPB_Messaging_1_0 { ...@@ -73,12 +73,11 @@ struct PPB_Messaging_1_0 {
* </script> * </script>
* </body> * </body>
* *
* </code> * @endcode
* *
* The module instance then invokes PostMessage() as follows: * The module instance then invokes PostMessage() as follows:
* *
* <code> * @code
*
* *
* char hello_world[] = "Hello world!"; * char hello_world[] = "Hello world!";
* PP_Var hello_var = ppb_var_interface->VarFromUtf8(instance, * PP_Var hello_var = ppb_var_interface->VarFromUtf8(instance,
...@@ -87,7 +86,7 @@ struct PPB_Messaging_1_0 { ...@@ -87,7 +86,7 @@ struct PPB_Messaging_1_0 {
* ppb_messaging_interface->PostMessage(instance, hello_var); // Copies var. * ppb_messaging_interface->PostMessage(instance, hello_var); // Copies var.
* ppb_var_interface->Release(hello_var); * ppb_var_interface->Release(hello_var);
* *
* </code> * @endcode
* *
* The browser will pop-up an alert saying "Hello world!" * The browser will pop-up an alert saying "Hello world!"
*/ */
......
ppapi/c/ppp_messaging.h
View file @ ca9bc12c
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
* found in the LICENSE file. * found in the LICENSE file.
*/ */
/* From ppp_messaging.idl modified Wed Oct 5 14:06:02 2011. */ /* From ppp_messaging.idl modified Wed Jan 25 11:41:09 2012. */
#ifndef PPAPI_C_PPP_MESSAGING_H_ #ifndef PPAPI_C_PPP_MESSAGING_H_
#define PPAPI_C_PPP_MESSAGING_H_ #define PPAPI_C_PPP_MESSAGING_H_
...@@ -55,7 +55,7 @@ struct PPP_Messaging_1_0 { ...@@ -55,7 +55,7 @@ struct PPP_Messaging_1_0 {
* *
* <strong>Example:</strong> * <strong>Example:</strong>
* *
* <code> * @code
* *
* <body> * <body>
* <object id="plugin" * <object id="plugin"
...@@ -65,7 +65,7 @@ struct PPP_Messaging_1_0 { ...@@ -65,7 +65,7 @@ struct PPP_Messaging_1_0 {
* </script> * </script>
* </body> * </body>
* *
* </code> * @endcode
* *
*/ */
void (*HandleMessage)(PP_Instance instance, struct PP_Var message); void (*HandleMessage)(PP_Instance instance, struct PP_Var message);
......
ppapi/cpp/audio_config.h
View file @ ca9bc12c
...@@ -19,8 +19,9 @@ namespace pp { ...@@ -19,8 +19,9 @@ namespace pp {
class InstanceHandle; class InstanceHandle;
/// A 16 bit stereo AudioConfig resource. Refer to the /// A 16 bit stereo AudioConfig resource. Refer to the
/// <a href="/chrome/nativeclient/docs/audio.html">Pepper /// <a href="/native-client/{{pepperversion}}/devguide/coding/audio">Audio
/// Audio API Code Walkthrough</a> for information on using this interface. /// </a> chapter in the Developer's Guide for information on using this
/// interface.
/// ///
/// A single sample frame on a stereo device means one value for the left /// A single sample frame on a stereo device means one value for the left
/// channel and one value for the right channel. /// channel and one value for the right channel.
...@@ -40,7 +41,7 @@ class InstanceHandle; ...@@ -40,7 +41,7 @@ class InstanceHandle;
/// Data will always be in the native endian format of the platform. /// Data will always be in the native endian format of the platform.
/// ///
/// <strong>Example:</strong> /// <strong>Example:</strong>
/// <code> /// @code
/// ///
/// // Create an audio config with a supported frame count. /// // Create an audio config with a supported frame count.
/// uint32_t sample_frame_count = AudioConfig::RecommendSampleFrameCount( /// uint32_t sample_frame_count = AudioConfig::RecommendSampleFrameCount(
...@@ -53,7 +54,7 @@ class InstanceHandle; ...@@ -53,7 +54,7 @@ class InstanceHandle;
/// Audio audio(instance, config, callback, user_data); /// Audio audio(instance, config, callback, user_data);
/// if (audio.is_null()) /// if (audio.is_null())
/// return false; // Couldn't create audio. /// return false; // Couldn't create audio.
/// </code> /// @endcode
class AudioConfig : public Resource { class AudioConfig : public Resource {
public: public:
/// An empty constructor for an <code>AudioConfig</code> resource. /// An empty constructor for an <code>AudioConfig</code> resource.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment