typo, parameter and type fixes
[mdref/mdref-http] / http / Encoding / Stream / Dechunk / decode.md
index e87d79e3cae6dd53561f20419732d344ef0264f3..bfca9caaa81a532f34f8c2829c1575d38c8db28f 100644 (file)
@@ -1,4 +1,4 @@
-# static string http\Encoding\Stream\Dechunk::decode(string $data)
+# static string http\Encoding\Stream\Dechunk::decode(string $data[, int &$decoded_len = 0])
 
 Decode chunked encoded data.
 
@@ -6,7 +6,21 @@ Decode chunked encoded data.
 
 * string $data  
   The data to decode.
+* Optional int &$decoded_len = 0  
+  Out parameter with the length of $data that's been decoded.
+  Should be ```strlen($data)``` if not truncated.
 
 ## Returns:
 
 * string, the decoded data.
+* string, the unencoded data.
+* string, the truncated decoded data.
+* false, if $data cannot be decoded.
+
+## Notices:
+
+* If $data does not seem to be chunked encoded.
+
+## Warnings:
+
+* If $data cannot be decoded or is truncated.