comments only: update docs for SkStream::readData(), SkWStream::writeData()

BUG=https://code.google.com/p/skia/issues/detail?id=1167
Review URL: https://codereview.chromium.org/12604012

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

1 files changed, 10 insertions, 2 deletions

diff --git a/include/core/SkStream.h b/include/core/SkStream.h
index c9418709a1..30855b35f4 100644
--- a/include/core/SkStream.h
+++ b/include/core/SkStream.h
@@ -73,8 +73,8 @@ public:
     size_t   readPackedUInt();
 
     /**
-     *  Create a new SkData from the stream contents. This balances the call
-     *  SkWStream::writeData().
+     *  Reconstitute an SkData object that was written to the stream
+     *  using SkWStream::writeData().
      */
     SkData* readData();
 
@@ -115,6 +115,14 @@ public:
 
     bool writeStream(SkStream* input, size_t length);
 
+    /**
+     * Append an SkData object to the stream, such that it can be read
+     * out of the stream using SkStream::readData().
+     *
+     * Note that the encoding method used to write the SkData object
+     * to the stream may change over time.  This method DOES NOT
+     * just write the raw content of the SkData object to the stream.
+     */
     bool writeData(const SkData*);
 };