diff options
author | jond@google.com <jond@google.com@0039d316-1c4b-4281-b951-d872f2087c98> | 2011-08-23 15:01:06 +0000 |
---|---|---|
committer | jond@google.com <jond@google.com@0039d316-1c4b-4281-b951-d872f2087c98> | 2011-08-23 15:01:06 +0000 |
commit | 44f4f3120bfb6334b491da1876f3bc798104546a (patch) | |
tree | ec4f417eee9ec0eee14a8ca15eff62a4ee84e5f9 /ppapi/cpp | |
parent | 10d8ea6d242a2c8de51c4e90ca7f3846aeac0bf7 (diff) | |
download | chromium_src-44f4f3120bfb6334b491da1876f3bc798104546a.zip chromium_src-44f4f3120bfb6334b491da1876f3bc798104546a.tar.gz chromium_src-44f4f3120bfb6334b491da1876f3bc798104546a.tar.bz2 |
Fixed references such that all begin "Refer to xyz for further information."
Doxygen will create links for xyz (don't need @see).
Review URL: http://codereview.chromium.org/7711014
git-svn-id: svn://svn.chromium.org/chrome/trunk/src@97859 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'ppapi/cpp')
-rw-r--r-- | ppapi/cpp/instance.h | 7 | ||||
-rw-r--r-- | ppapi/cpp/paint_aggregator.h | 5 | ||||
-rw-r--r-- | ppapi/cpp/paint_manager.h | 11 |
3 files changed, 14 insertions, 9 deletions
diff --git a/ppapi/cpp/instance.h b/ppapi/cpp/instance.h index 6578ea7..da21806 100644 --- a/ppapi/cpp/instance.h +++ b/ppapi/cpp/instance.h @@ -272,7 +272,8 @@ class Instance { bool BindGraphics(const Graphics2D& graphics); /// Binds the given Graphics3D as the current display surface. - /// See BindGraphics(const Graphics2D& graphics). + /// Refer to <code>BindGraphics(const Graphics2D& graphics)</code> for + /// further information. /// /// @param[in] graphics A <code>Graphics3D_Dev</code> to bind. /// @@ -282,7 +283,9 @@ class Instance { bool BindGraphics(const Graphics3D_Dev& graphics); /// Binds the given Surface3D as the current display surface. - /// See BindGraphics(const Graphics2D& graphics). + /// Refer to <code>BindGraphics(const Graphics2D& graphics)</code> for + /// further information. + /// /// @param[in] graphics A <code>Surface3D_Dev</code> to bind. /// /// @return true if bind was successful or false if the device was not the diff --git a/ppapi/cpp/paint_aggregator.h b/ppapi/cpp/paint_aggregator.h index 85c4442..db1e04c 100644 --- a/ppapi/cpp/paint_aggregator.h +++ b/ppapi/cpp/paint_aggregator.h @@ -22,7 +22,8 @@ namespace pp { /// additionally handle the necessary callbacks on top of the PaintAggregator /// functionality. /// -/// See http://code.google.com/p/ppapi/wiki/2DPaintingModel +/// Refer to <code>http://code.google.com/p/ppapi/wiki/2DPaintingModel</code> +/// for further information. class PaintAggregator { public: struct PaintUpdate { @@ -93,7 +94,7 @@ class PaintAggregator { /// PendingUpdate if InvalidateRect or ScrollRect were called and /// ClearPendingUpdate was not called. /// - /// @return True if there is a pending update, otherwise false. + /// @return true if there is a pending update, otherwise false. bool HasPendingUpdate() const; /// This function clears a pending update. diff --git a/ppapi/cpp/paint_manager.h b/ppapi/cpp/paint_manager.h index e86dc92..809946b 100644 --- a/ppapi/cpp/paint_manager.h +++ b/ppapi/cpp/paint_manager.h @@ -180,11 +180,12 @@ class PaintManager { } /// Setter function for setting the maximum number of paint rects. If we - /// exceed this limit, then we'll start combining paint rects (see - /// CombinePaintRects(). This limiting can be important since there is - /// typically some overhead in deciding what to paint. If your module is fast - /// at doing these computations, raise this threshold, if your module is - /// slow, lower it (probably requires some tuning to find the right value). + /// exceed this limit, then we'll start combining paint rects (refer to + /// CombinePaintRects() for further information). This limiting can be + /// important since there is typically some overhead in deciding what to + /// paint. If your module is fast at doing these computations, raise this + /// threshold, if your module is slow, lower it (probably requires some + /// tuning to find the right value). /// /// @param[in] max_rects The maximum number of paint rects. void set_max_paint_rects(size_t max_rects) { |