New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Multiline example captions not supported #190

Open

callmehiphop opened this issue Jan 30, 2019 · 0 comments

callmehiphop commented Jan 30, 2019

Using this as an example

/**
 * @example
 * thing.method(callback);
 *
 * @example <caption>If the callback is omitted, we'll return a Promise
 * in its place.</caption>
 * thing.method().catch(err => {});
 */

Results in something like this

thing.method(callback);

<caption>If the callback is omitted, we'll return a Promise
in its place</caption>
thing.method().catch(err => {});

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment