dmd
dmd copied to clipboard
jsdoc2md
The default output template for jsdoc2md
In `index.js`, line 92 loads the default partials as follows: ``` registerPartials(path.resolve(__dirname, './partials/**/*.hbs')) ``` The glob path gests unfolded usign `FileSet` which in turns uses `glob`. The problem is that,...
Currently `async` functions are not emphasized in any way. On the other hand JSDoc by default specifically emphasizes them, discussion on the design is in https://github.com/jsdoc/jsdoc/issues/1188. It would be really...
Given a typedef: ``` /** * Playback position expressed in bars:quarters:sixteenths format (e.g. `"1:2:0"`) * @typedef {string} transportTime * @global */ ``` When that type is used in a param:...
In order to support a grouping globals by category, let's add a `groupGlobalsBy(groupByFields, options)` function. Currently, you can only really group by category if the grouped identifiers are part of...
It would be really cool for this plugin's output to be able to conform to markdown linters, such as this one https://github.com/DavidAnson/markdownlint.
### Summary jsdoc tags `@file` and its synonims `@overview` and `@fileoverview` seem to be ignored by `jsdoc-to-markdown` #### Steps to reproduce Create a file with the following contents: ``` js...
There's no mention of type in in the output for event (output in jsdoc2md/jsdoc-to-markdown#9 suggests there once was). Source: ``` /** * Instance of Test * * @constructor */ function...
``` js /** * Both of these will link to the bar function. * @see {@link bar} * @see bar */ function foo() {} ``` [docs](http://usejsdoc.org/tags-see.html) Input: ``` js /**...
I have the following js (`simple.js`): ``` /** * foo! * @category A */ function foo(){} /** * bar! * @category A */ function bar(){} /** * baz! * @category...
Given this input: ```js import { pipe, toLower, split, join, filter } from 'ramda'; const randomChars = n => Math.random().toString(36).split('').slice(-(n)).join(''); const stripInvalid = str => str.replace(/[^a-zA-Z0-9-]/g, ''); const removeDashes =...
