improving documentation

Author: andreagilardoni

src/decompress/lzss.h

@@ -25,8 +25,19 @@ void lzss_flush();
 class LZSSDecoder {
 public:
 
+    /**
+     * Build an LZSS decoder by providing a callback for storing the decoded bytes
+     * @param putc_cbk: a callback that takes a char and stores it e.g. a callback to fwrite
+     */
     LZSSDecoder(std::function<void(const uint8_t)> putc_cbk);
 
+    /**
+     * Build an LZSS decoder providing a callback for getting a char and putting a char
+     * in this way you need to call decompress with no parameters
+     * @param putc_cbk: a callback that takes a char and stores it e.g. a callback to fwrite
+     * @param getc_cbk: a callback that returns the next char to consume
+     *                  -1 means EOF, -2 means buffer is temporairly finished
+     */
     LZSSDecoder(std::function<int()> getc_cbk, std::function<void(const uint8_t)> putc_cbk);
 
     /**
@@ -43,7 +54,7 @@ class LZSSDecoder {
 
     /**
      * decode the provided buffer until buffer ends, then pause the process
-     * @return 0 if the decompression is completed, 1 if not
+     * @return DONE if the decompression is completed, NOT_COMPLETED if not
      */
     status decompress(const char* buffer, uint32_t size);
 private: