meteor-jsdoc icon indicating copy to clipboard operation
meteor-jsdoc copied to clipboard

Support for large markdown blocks before and after functions

Open fabienb4 opened this issue 9 years ago • 0 comments

We need a way to add markdown blocks before and after functions docs like on meteor publish. @before and @after are nice for small things like titles or notes, but large amount of markdown will make the code painful to read.

A suggestion was to be able to include markdown files for any function requiring more details using something like:

/**
 * @summary Whatever.
 * @partial myfunction.md
 */

Although it would work, I think it will make large projects very hard to maintain, with a bunch of files here and there and their inclusions inside the project's code. See #24.

Any ideas/pull request welcome.

fabienb4 avatar Nov 13 '15 04:11 fabienb4