jsdoc-plugin-testspec

JSDoc plugin which connects inline comments & mocha tests specs with docs elements.

Description

JPST (jsdoc-plugin-testSpec) is jsdoc's plugin which connects inline comments & mocha tests specs with docs elements. Lets see example of files and what is generated with this plugin.

Source:

let t;
 
/**
 * module:basic~testFunction
 */
function testFunction(){
    // Inline comment.
    // Inline another comment.
}
 
/**
 * @test module:basic~testFunction
 */
t = describe('<your description>', () => {
    it('first test specification');
    it('second test specification');
});

Results:

Homepage

For more informations please visit projects official homepage.

https://urosjarc.github.io/jsdoc-plugin-testSpec

License

Copyright © 2016 Uroš Jarc

MIT License