瀏覽代碼

update comments

David Rose 23 年之前
父節點
當前提交
3e4776566d
共有 2 個文件被更改,包括 8 次插入1 次删除
  1. 4 1
      panda/src/express/subStream.I
  2. 4 0
      panda/src/express/subStream.h

+ 4 - 1
panda/src/express/subStream.I

@@ -35,6 +35,9 @@ ISubStream() : istream(&_buf) {
 //               start total characters.  The character at "end"
 //               within the source will never be read; this will
 //               appear to be EOF.
+//
+//               If end is zero, it indicates that the ISubStream will
+//               continue until the end of the source stream.
 ////////////////////////////////////////////////////////////////////
 INLINE void ISubStream::
 open(istream *source, streampos start, streampos end) {
@@ -46,7 +49,7 @@ open(istream *source, streampos start, streampos end) {
 //     Function: ISubStream::close
 //       Access: Public
 //  Description: Resets the SubStream to empty, but does not actually
-//               close its source istream.
+//               close the source istream.
 ////////////////////////////////////////////////////////////////////
 INLINE void ISubStream::
 close() {

+ 4 - 0
panda/src/express/subStream.h

@@ -29,6 +29,10 @@
 //               stream will be the "start" character from the source
 //               istream; just before the file pointer reaches the
 //               "end" character, eof is returned.
+//
+//               The source stream must be one that we can randomly
+//               seek within.  The resulting ISubStream will also
+//               support arbitrary seeks.
 ////////////////////////////////////////////////////////////////////
 class EXPCL_PANDAEXPRESS ISubStream : public istream {
 public: