Add doc on SkCanvas::drawImage*() methods

BUG=skia:2947
R=junov@chromium.org, reed@google.com

Author: piotaixr@chromium.org

Review URL: https://codereview.chromium.org/595043002

1 files changed, 16 insertions, 0 deletions

diff --git a/include/core/SkCanvas.h b/include/core/SkCanvas.h
index 5828466d62..5998ee5a30 100644
--- a/include/core/SkCanvas.h
+++ b/include/core/SkCanvas.h
@@ -812,9 +812,25 @@ public:
     */
     virtual void drawPath(const SkPath& path, const SkPaint& paint);
 
+    /** Draw the specified image, with its top/left corner at (x,y), using the
+        specified paint, transformed by the current matrix.
+
+        @param image    The image to be drawn
+        @param left     The position of the left side of the image being drawn
+        @param top      The position of the top side of the image being drawn
+        @param paint    The paint used to draw the image, or NULL
+     */
     virtual void drawImage(const SkImage* image, SkScalar left, SkScalar top,
                            const SkPaint* paint = NULL);
+    /** Draw the specified image, with the specified matrix applied (before the
+        canvas' matrix is applied).
 
+        @param image   The image to be drawn
+        @param src      Optional: specify the subset of the image to be drawn
+        @param dst      The destination rectangle where the scaled/translated
+                        image will be drawn
+        @param paint    The paint used to draw the image, or NULL
+    */
     virtual void drawImageRect(const SkImage* image, const SkRect* src,
                                const SkRect& dst,
                                const SkPaint* paint = NULL);