1
0
Fork 0
forked from 0x2620/oxjs

in documentation use foo, not <code>foo</code>

This commit is contained in:
rolux 2012-06-02 13:06:44 +02:00
commit 73fa856900
16 changed files with 89 additions and 105 deletions

View file

@ -140,11 +140,10 @@ Ox.decodeBase256 = function(string) {
/*@
Ox.encodeDeflate <f> Encodes a string, using deflate
Since PNGs are deflate-encoded, the <code>canvas</code> object's
<code>toDataURL</code> method provides an efficient implementation.
The string is encoded as UTF-8 and written to the RGB channels of a
canvas element, then the PNG dataURL is decoded from base64, and some
head, tail and chunk names are removed.
Since PNGs are deflate-encoded, the `canvas` object's `toDataURL` method
provides an efficient implementation. The string is encoded as UTF-8 and
written to the RGB channels of a canvas element, then the PNG dataURL is
decoded from base64, and some head, tail and chunk names are removed.
(str) -> <s> The encoded string
str <s> The string to be encoded
> Ox.decodeDeflate(Ox.encodeDeflate('foo'), function(str) { Ox.test(str, 'foo'); })
@ -189,11 +188,10 @@ Ox.encodeDeflate = function(string, callback) {
/*@
Ox.decodeDeflate <f> Decodes an deflate-encoded string
Since PNGs are deflate-encoded, the <code>canvas</code> object's
<code>drawImage</code> method provides an efficient implementation. The
string will be wrapped as a PNG dataURL, encoded as base64, and drawn
onto a canvas element, then the RGB channels will be read, and the
result will be decoded from UTF8.
Since PNGs are deflate-encoded, the `canvas` object's `drawImage` method
provides an efficient implementation. The string will be wrapped as a PNG
dataURL, encoded as base64, and drawn onto a canvas element, then the RGB
channels will be read, and the result will be decoded from UTF8.
(str) -> <u> undefined
str <s> The string to be decoded
callback <f> Callback function