Skip to content

Multiline example captions not supported #190

@callmehiphop

Description

@callmehiphop

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 => {});

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions