delta/node.git/doc/api/buffer.markdown, branch node-review

buffer, doc: misc. fix and cleanup

2014-10-08T09:24:32+00:00

* Add official documentation that a Buffer instance is a viable
  argument when instantiating a new Buffer.
* Properly set the poolOffset when a buffer needs to be truncated.
* Add comments clarifying specific peculiar coding choices.
* Remove a level of unnecessary indentation.

Signed-off-by: Trevor Norris

buffer: add generic functions for (u)int ops

2014-10-03T08:31:20+00:00

Add generic functions for (U)Int read/write operations on Buffers. These
support up to and including 48 bit reads and writes.

Include documentation and tests.

Additional work done by Trevor Norris to include 40 and 48 bit write
support. Because bitwise operations cannot be used on values greater
than 32 bits, the operations have been replaced with mathematical
calculations. Regardless, they are still faster than floating point
operations.

Reviewed-by: Trevor Norris

doc: fix optional parameter parsing

2014-09-29T23:32:34+00:00

The parameter parser specifically looked for the old bracket syntax.
This generated a lot of warnings when building the docs. Those warnings
have been fixed by changing the parsing logic.

Signed-off-by: Trevor Norris

doc: fix brackets for optional parameters

2014-09-25T18:26:15+00:00

Documentation incorrectly used bracket notation for optional parameters.
This caused inconsistencies in usage because of examples like the
following:

    fs.write(fd, data[, position[, encoding]], callback)

This simply fixes all uses of bracket notation in documentation.

Signed-off-by: Trevor Norris 
Reviewed-by: Fedor Indutny

doc: document max `new Buffer(size)`

2014-08-07T23:47:01+00:00

Signed-off-by: Timothy J Fontaine

Merge remote-tracking branch 'origin/v0.10' into master

2014-07-29T08:51:27+00:00

Conflicts:
	doc/api/buffer.markdown
	lib/_stream_readable.js
	lib/assert.js
	lib/buffer.js
	lib/child_process.js
	lib/http.js
	lib/string_decoder.js
	lib/zlib.js
	node.gyp
	test/simple/test-buffer.js
	test/simple/test-https-foafssl.js
	test/simple/test-stream2-compatibility.js
	test/simple/test-tls-server-verify.js

doc: buffer: clarify typed array construction

2014-06-23T06:45:40+00:00

It's possible to construct a typed array from a buffer but the buffer
is treated as an array, not a byte array as one might expect.

Fixes #7786.

Signed-off-by: Trevor Norris

buffer: remove Buffer#toArrayBuffer()

2014-05-12T23:58:30+00:00

A recent change to v8's API now makes it impossible to memcpy to a
v8::ArrayBuffer without causing it to be externalized. This means that
the garbage collector will not automatically free the memory when the
object is collected.

When/If the necessary API is included to allow the above
Buffer#toArrayBuffer() will be reintroduced.

Signed-off-by: Timothy J Fontaine

buffer: add compare and equals methods

2014-04-29T05:09:48+00:00

compare() works like String.localeCompare such that:

    Buffer.compare(a, b) === a.compare(b);

equals() does a native check to see if two buffers are equal.

Signed-off-by: Trevor Norris

buffer: add buf.toArrayBuffer() API

2013-10-11T19:17:23+00:00