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

include/core/SkStream.h

 
 /*
  * Copyright 2006 The Android Open Source Project
  *
  * Use of this source code is governed by a BSD-style license that can be
  * found in the LICENSE file.
  */
 
 
 #ifndef SkStream_DEFINED
@@ skipping 55 matching lines @@
 
     uint8_t  readU8() { return (uint8_t)this->readS8(); }
     uint16_t readU16() { return (uint16_t)this->readS16(); }
     uint32_t readU32() { return (uint32_t)this->readS32(); }
 
     bool     readBool() { return this->readU8() != 0; }
     SkScalar readScalar();
     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();
 
 private:
     typedef SkRefCnt INHERITED;
 };
 
 class SK_API SkWStream : SkNoncopyable {
 public:
     SK_DECLARE_INST_COUNT_ROOT(SkWStream)
@@ skipping 20 matching lines @@
     bool    writeBigDecAsText(int64_t, int minDigits = 0);
     bool    writeHexAsText(uint32_t, int minDigits = 0);
     bool    writeScalarAsText(SkScalar);
 
     bool    writeBool(bool v) { return this->write8(v); }
     bool    writeScalar(SkScalar);
     bool    writePackedUInt(size_t);
 
     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*);
 };
 
 ////////////////////////////////////////////////////////////////////////////////////////
 
 #include "SkString.h"
 
 struct SkFILE;
 
 /** A stream that reads from a FILE*, which is opened in the constructor and
@@ skipping 252 matching lines @@
     virtual void newline() SK_OVERRIDE;
 
 private:
     typedef SkWStream INHERITED;
 };
 
 // for now
 typedef SkFILEStream SkURLStream;
 
 #endif