docref
v0.0.6
Published
Code documentation by reference
Downloads
6
Readme
docref
Imports jsDoc comments from external files, via jsDoc-like reference:
/**
* @docref
* @file src/product.js
* @match Product.buy
*/
buy(id: string, count: number):Receipt
See the Rationale for this project.
IMPORTANT: It is currently at the stage of writing Specification.
installing
$npm install docref -g
usage
Run docref
without arguments, to see the supported syntax.