diff options
| author | Trevor Norris <trev.norris@gmail.com> | 2013-11-13 15:14:34 -0800 |
|---|---|---|
| committer | Trevor Norris <trev.norris@gmail.com> | 2013-11-13 15:31:22 -0800 |
| commit | 26a795baa10943a94708646a001f594a38a0b238 (patch) | |
| tree | 0ae8b2521d51042fb424f6f7fb9143a15e9b8a39 | |
| parent | c414ec1c2cdff8111a60f62f445011708bfd81ba (diff) | |
| download | node-new-26a795baa10943a94708646a001f594a38a0b238.tar.gz | |
doc: fix few smalloc entries for proper formatting
| -rw-r--r-- | doc/api/smalloc.markdown | 23 |
1 files changed, 10 insertions, 13 deletions
diff --git a/doc/api/smalloc.markdown b/doc/api/smalloc.markdown index e434ee24ca..72e46ea587 100644 --- a/doc/api/smalloc.markdown +++ b/doc/api/smalloc.markdown @@ -2,14 +2,11 @@ Stability: 1 - Experimental -`Smalloc` is a light weight API that allows developers to attach external data -to arbitrary `Object`s. - ## smalloc.alloc(length[, receiver][, type]) -* `length` {Number} `<= kMaxLength` (maximum allowed Buffer size by v8) -* `receiver` {Object} Optional, Default: `new Object()` -* `type` {Enum} Optional, Default: `Uint8` +* `length` {Number} `<= smalloc.kMaxLength` +* `receiver` {Object}, Optional, Default: `new Object` +* `type` {Enum}, Optional, Default: `Uint8` Returns `receiver` with allocated external array data. If no `receiver` is passed then a new Object will be created and returned. @@ -49,13 +46,13 @@ possible options are listed in `smalloc.Types`. Example usage: // { '0': 0, '1': 0.1, '2': 0.2 } -## smalloc.copyOnto(source, sourceStart, dest, destStart, copyLength) +## smalloc.copyOnto(source, sourceStart, dest, destStart, copyLength); -* `source` {Object} with external array allocation -* `sourceStart` {Position} to begin copying from -* `dest` {Object} with external array allocation -* `destStart` {Position} to begin copying onto -* `copyLength` {Length} of copy +* `source` Object with external array allocation +* `sourceStart` Position to begin copying from +* `dest` Object with external array allocation +* `destStart` Position to begin copying onto +* `copyLength` Length of copy Copy memory from one external array allocation to another. No arguments are optional, and any violation will throw. @@ -80,7 +77,7 @@ need to set any additional properties for this to work. ## smalloc.dispose(obj) -* `obj` {Object} +* `obj` Object Free memory that has been allocated to an object via `smalloc.alloc`. |