jdalton / docdown

A simple JSDoc to Markdown generator.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Issue with multi-line function descriptions

mathiasbynens opened this issue · comments

    /**
     * Foo bar baz let's say this line is very long and reaches the 80-char limit
     * but the sentence continues on the next line, or maybe it's even longer
     * and makes it all the way to the third line.
     * @memberOf foo
     * @param {String} input lorem ipsum.
     * @returns {String} lorem ipsum.
     */
    function x(y) {}

Generates the following Markdown:

Foo bar baz let's say this line is very long and reaches the 80-char limit
     * but the sentence continues on the next line, or maybe it's even longer
     * and makes it all the way to the third line.

In other words, the tab + space + * character isn’t trimmed from the second (and third, fourth, etc.) line. This is an issue when generating docs for Punycode.js.

Have you tried this in the latest version?
I have several places in Lo-Dash's doc that have these multiline comments w/o problems.

Yes, the issue occurs in the latest available DocDown version. It used to work fine before, but I don’t know in which commit the bug was introduced.

Maybe it’s because I’m using tabs for indentation? Lo-Dash uses two-space indents.

Can you try again with edge. I patched it to allow tabs and spaces.

Yup, 0c7d38d fixed it! Thanks!