浏览代码

2008-07-01 Tatsuhiro Tsujikawa <tujikawa at rednoah dot com>

	Updated doc
	* src/Decoder.h
Tatsuhiro Tsujikawa 17 年之前
父节点
当前提交
151624ffcb
共有 2 个文件被更改,包括 9 次插入0 次删除
  1. 5 0
      ChangeLog
  2. 4 0
      src/Decoder.h

+ 5 - 0
ChangeLog

@@ -1,3 +1,8 @@
+2008-07-01  Tatsuhiro Tsujikawa  <tujikawa at rednoah dot com>
+
+	Updated doc
+	* src/Decoder.h
+
 2008-06-30  Tatsuhiro Tsujikawa  <tujikawa at rednoah dot com>
 
 	Updated usage text for -s option.

+ 4 - 0
src/Decoder.h

@@ -40,16 +40,20 @@
 
 namespace aria2 {
 
+// Interface for basic decoding functionality.
 class Decoder {
 public:
   virtual ~Decoder() {}
 
+  // init() must be called before calling decode().
   virtual void init() = 0;
 
   virtual std::string decode(const unsigned char* inbuf, size_t inlen) = 0;
 
   virtual bool finished() = 0;
 
+  // The call of release() will free allocated resources.
+  // After calling release(), the object can be reused by calling init().
   virtual void release() = 0;
 
   virtual const std::string& getName() const = 0;