Skip to content

vitaly-t/docref

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

Build Status Coverage Status Join the Chat

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.

About

Code documentation by reference

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published