1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc,tools,test: lint doc-based addon tests

Browse Source 
PR-URL: https://github.com/nodejs/node/pull/5427
Fixes: https://github.com/nodejs/node/issues/5424
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
This commit is contained in:
Rich Trott 2016-02-24 17:07:45 -08:00
parent c98d159ed3
commit 3e3d941495
2 changed files with 17 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
doc/api/addons.markdown
View File

@ -318,7 +318,7 @@ Once compiled, the example Addon can be required and used from within Node.js:
// test.js // test.js
const addon = require('./build/Release/addon'); const addon = require('./build/Release/addon');
console.log('This should be eight:', addon.add(3,5)); console.log('This should be eight:', addon.add(3, 5));
``` ```
@ -423,7 +423,7 @@ const addon = require('./build/Release/addon');
var obj1 = addon('hello'); var obj1 = addon('hello');
var obj2 = addon('world'); var obj2 = addon('world');
console.log(obj1.msg+' '+obj2.msg); // 'hello world' console.log(obj1.msg + ' ' + obj2.msg); // 'hello world'
``` ```
@ -638,9 +638,9 @@ Test it with:
const addon = require('./build/Release/addon'); const addon = require('./build/Release/addon');
var obj = new addon.MyObject(10); var obj = new addon.MyObject(10);
console.log( obj.plusOne() ); // 11 console.log(obj.plusOne()); // 11
console.log( obj.plusOne() ); // 12 console.log(obj.plusOne()); // 12
console.log( obj.plusOne() ); // 13 console.log(obj.plusOne()); // 13
``` ```
### Factory of wrapped objects ### Factory of wrapped objects
@ -824,14 +824,14 @@ Test it with:
const createObject = require('./build/Release/addon'); const createObject = require('./build/Release/addon');
var obj = createObject(10); var obj = createObject(10);
console.log( obj.plusOne() ); // 11 console.log(obj.plusOne()); // 11
console.log( obj.plusOne() ); // 12 console.log(obj.plusOne()); // 12
console.log( obj.plusOne() ); // 13 console.log(obj.plusOne()); // 13
var obj2 = createObject(20); var obj2 = createObject(20);
console.log( obj2.plusOne() ); // 21 console.log(obj2.plusOne()); // 21
console.log( obj2.plusOne() ); // 22 console.log(obj2.plusOne()); // 22
console.log( obj2.plusOne() ); // 23 console.log(obj2.plusOne()); // 23
``` ```

6
tools/doc/addon-verify.js
View File

@ -70,6 +70,12 @@ function verifyFiles(files, blockName, onprogress, ondone) {
); );
files = Object.keys(files).map(function(name) { files = Object.keys(files).map(function(name) {
if (name === 'test.js') {
files[name] = `'use strict';
require('../../common');
${files[name]}
`;
}
return { return {
path: path.resolve(dir, name), path: path.resolve(dir, name),
name: name, name: name,