document the return value of append()

git-svn-id: http://skia.googlecode.com/svn/trunk@521 2bbb7eff-a529-9590-31e7-b0007b416f81

diff --git a/src/core/SkPathHeap.h b/src/core/SkPathHeap.h
index b8f3bd3..1a0023c 100644 (file)
--- a/src/core/SkPathHeap.h
+++ b/src/core/SkPathHeap.h
@@ -15,7 +15,10 @@ public:
             SkPathHeap(SkFlattenableReadBuffer&);
     virtual ~SkPathHeap();
 
-    // called during picture-record
+    /** Copy the path into the heap, and return the new total number of paths.
+        Thus, the returned value will be index+1, where index is the index of
+        this newly added (copied) path.
+     */
     int append(const SkPath&);
     
     // called during picture-playback