summaryrefslogtreecommitdiffstats
path: root/ppapi/cpp
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/cpp
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/cpp')
-rw-r--r--ppapi/cpp/audio_config.h7
-rw-r--r--ppapi/cpp/completion_callback.h8
-rw-r--r--ppapi/cpp/input_event.h4
-rw-r--r--ppapi/cpp/instance.h20
-rw-r--r--ppapi/cpp/paint_manager.h4
-rw-r--r--ppapi/cpp/url_loader.h66
6 files changed, 26 insertions, 83 deletions
diff --git a/ppapi/cpp/audio_config.h b/ppapi/cpp/audio_config.h
index dfb7cf3..2eac4d6 100644
--- a/ppapi/cpp/audio_config.h
+++ b/ppapi/cpp/audio_config.h
@@ -40,7 +40,8 @@ class Instance;
/// Data will always be in the native endian format of the platform.
///
/// <strong>Example:</strong>
-/// @code
+/// <code>
+///
/// // Create an audio config with a supported frame count.
/// uint32_t sample_frame_count = AudioConfig::RecommendSampleFrameCount(
/// PP_AUDIOSAMPLERATE_44100, 4096);
@@ -52,7 +53,7 @@ class Instance;
/// Audio audio(instance, config, callback, user_data);
/// if (audio.is_null())
/// return false; // Couldn't create audio.
-/// @endcode
+/// </code>
class AudioConfig : public Resource {
public:
/// An empty constructor for an <code>AudioConfig</code> resource.
@@ -63,7 +64,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 A pointer to an <code>Instance</code> indentifying
+ /// @param[in] instance A pointer to an <code>Instance</code> identifying
/// one instance of a module.
/// @param[in] sample_rate A <code>PP_AudioSampleRate</code> which is either
/// <code>PP_AUDIOSAMPLERATE_44100</code> or
diff --git a/ppapi/cpp/completion_callback.h b/ppapi/cpp/completion_callback.h
index 797fb83..0a4f5bf 100644
--- a/ppapi/cpp/completion_callback.h
+++ b/ppapi/cpp/completion_callback.h
@@ -113,7 +113,7 @@ class CompletionCallback {
///
/// <strong>Example:</strong>
///
- /// @code
+ /// <code>
///
/// int32_t OpenURL(pp::URLLoader* loader,
/// pp::URLRequestInfo* url_request_info,
@@ -123,7 +123,7 @@ class CompletionCallback {
/// return loader->Open(*loader, *url_request_info, cc);
/// }
///
- /// @endcode
+ /// </code>
///
/// @param[in] result PP_OK_COMPLETIONPENDING or the result of the completed
/// operation to be passed to the callback function. PP_OK_COMPLETIONPENDING
@@ -172,7 +172,7 @@ CompletionCallback BlockUntilComplete();
///
/// <strong>Example: </strong>
///
-/// @code
+/// <code>
///
/// class MyHandler {
/// public:
@@ -231,7 +231,7 @@ CompletionCallback BlockUntilComplete();
/// int64_t offset_;
/// };
///
-/// @endcode
+/// </code>
///
template <typename T, typename RefCount = NonThreadSafeRefCount>
class CompletionCallbackFactory {
diff --git a/ppapi/cpp/input_event.h b/ppapi/cpp/input_event.h
index f634cb9..74c9e25 100644
--- a/ppapi/cpp/input_event.h
+++ b/ppapi/cpp/input_event.h
@@ -28,7 +28,7 @@ class Var;
/// appropriate event-specific object to query the properties.
///
/// <strong>Example:</strong>
-/// @code
+/// <code>
///
/// bool MyInstance::HandleInputEvent(const pp::InputEvent& event) {
/// switch (event.GetType()) {
@@ -40,7 +40,7 @@ class Var;
/// return false;
/// }
///
-/// @endcode
+/// </code>
class InputEvent : public Resource {
public:
/// Default constructor that creates an is_null() InputEvent object.
diff --git a/ppapi/cpp/instance.h b/ppapi/cpp/instance.h
index da21806..ea145f9 100644
--- a/ppapi/cpp/instance.h
+++ b/ppapi/cpp/instance.h
@@ -223,7 +223,7 @@ class Instance {
/// the instance on which it was invoked, with <code>message</code> being a
/// string <code>Var</code> containing "Hello world!"
///
- /// @code
+ /// <code>
///
/// <body>
/// <object id="plugin"
@@ -233,7 +233,7 @@ class Instance {
/// </script>
/// </body>
///
- /// @endcode
+ /// </code>
///
/// Refer to PostMessage() for sending messages to JavaScript.
///
@@ -327,12 +327,12 @@ class Instance {
///
/// <strong>Example:</strong>
///
- /// @code
+ /// <code>
/// RequestInputEvents(PP_INPUTEVENT_CLASS_MOUSE);
/// RequestFilteringInputEvents(
/// PP_INPUTEVENT_CLASS_WHEEL | PP_INPUTEVENT_CLASS_KEYBOARD);
///
- /// @endcode
+ /// </code>
///
/// @param event_classes A combination of flags from
/// <code>PP_InputEvent_Class</code> that identifies the classes of events
@@ -365,13 +365,13 @@ class Instance {
///
/// <strong>Example:</strong>
///
- /// @code
+ /// <code>
///
/// RequestInputEvents(PP_INPUTEVENT_CLASS_MOUSE);
/// RequestFilteringInputEvents(
/// PP_INPUTEVENT_CLASS_WHEEL | PP_INPUTEVENT_CLASS_KEYBOARD);
///
- /// @endcode
+ /// </code>
///
/// @param event_classes A combination of flags from
/// <code>PP_InputEvent_Class</code> that identifies the classes of events
@@ -412,7 +412,7 @@ class Instance {
///
/// <strong>Example:</strong>
///
- /// @code
+ /// <code>
///
/// <body>
/// <object id="plugin"
@@ -425,15 +425,15 @@ class Instance {
/// </script>
/// </body>
///
- /// @endcode
+ /// </code>
///
/// The instance then invokes PostMessage() as follows:
///
- /// @code
+ /// <code>
///
/// PostMessage(pp::Var("Hello world!"));
///
- /// @endcode
+ /// </code>
///
/// The browser will pop-up an alert saying "Hello world!"
///
diff --git a/ppapi/cpp/paint_manager.h b/ppapi/cpp/paint_manager.h
index 809946b..fbddd9f 100644
--- a/ppapi/cpp/paint_manager.h
+++ b/ppapi/cpp/paint_manager.h
@@ -32,7 +32,7 @@ class Rect;
///
/// <strong>Example:</strong>
///
-/// @code
+/// <code>
///
/// class MyClass : public pp::Instance, public PaintManager::Client {
/// public:
@@ -65,7 +65,7 @@ class Rect;
/// private:
/// pp::PaintManager paint_manager_;
/// };
-/// @endcode
+/// </code>
class PaintManager {
public:
class Client {
diff --git a/ppapi/cpp/url_loader.h b/ppapi/cpp/url_loader.h
index 63bfc00..6074cb9 100644
--- a/ppapi/cpp/url_loader.h
+++ b/ppapi/cpp/url_loader.h
@@ -18,67 +18,8 @@ class URLRequestInfo;
class URLResponseInfo;
/// URLLoader provides an API for loading URLs.
-///
-/// <strong>Example:</strong>
-///
-/// @code
-///
-/// class MyHandler {
-/// public:
-/// MyHandler(Instance* instance)
-/// : factory_(this),
-/// loader_(instance),
-/// did_open_(false) {
-/// }
-/// void ProcessURL(const char* url) {
-/// CompletionCallback* cc = NewCallback();
-/// int32_t rv = loader_.Open(MakeRequest(url), cc);
-/// if (rv != PP_Error_WouldBlock)
-/// cc->Run(rv);
-/// }
-/// private:
-/// CompletionCallback* NewCallback() {
-/// return factory_.NewOptionalCallback(&MyHandler::DidCompleteIO);
-/// }
-/// URLRequestInfo MakeRequest(const char* url) {
-/// URLRequestInfo request;
-/// request.SetURL(url);
-/// request.SetMethod("GET");
-/// request.SetFollowRedirects(true);
-/// return request;
-/// }
-/// void DidCompleteIO(int32_t result) {
-/// if (result > 0) {
-/// // buf_ now contains 'result' number of bytes from the URL.
-/// ProcessBytes(buf_, result);
-/// ReadMore();
-/// } else if (result == PP_OK && !did_open_) {
-/// // Headers are available, and we can start reading the body.
-/// did_open_ = true;
-/// ProcessResponseInfo(loader_.GetResponseInfo());
-/// ReadMore();
-/// } else {
-/// // Done reading (possibly with an error given by 'result').
-/// }
-/// }
-/// void ReadMore() {
-/// CompletionCallback* cc = NewCallback();
-/// int32_t rv = fio_.Read(offset_, buf_, sizeof(buf_), cc);
-/// if (rv != PP_Error_WouldBlock)
-/// cc->Run(rv);
-/// }
-/// void ProcessResponseInfo(const URLResponseInfo& response_info) {
-/// // Read response headers, etc.
-/// }
-/// void ProcessBytes(const char* bytes, int32_t length) {
-/// // Do work ...
-/// }
-/// pp::CompletionCallbackFactory<MyHandler> factory_;
-/// pp::URLLoader loader_;
-/// char buf_[4096];
-/// bool did_open_;
-/// };
-/// @endcode
+/// Refer to <code>ppapi/examples/url_loader/streaming.cc</code>
+/// for an example of how to use this class.
class URLLoader : public Resource {
public:
/// Default constructor for creating an is_null()
@@ -92,7 +33,8 @@ class URLLoader : public Resource {
/// A constructor used when a <code>PP_Resource</code> is provided as a
/// return value whose reference count we need to increment.
///
- /// @param[in] resource A <code>PP_Resource</code>.
+ /// @param[in] resource A <code>PP_Resource</code> corresponding to a
+ /// <code>URLLoader</code> resource.
explicit URLLoader(PP_Resource resource);
/// A constructor used to allocate a new URLLoader in the browser. The
generated by cgit v1.1 at 2025-02-07 00:05:05 +0000