webdoc-labs / webdoc

Documentation generator for the web
https://www.webdoclabs.com
Other
79 stars 9 forks source link

Issue with interface properties in 1.2.1? #111

Closed bigtimebuddy closed 3 years ago

bigtimebuddy commented 3 years ago

Not sure if this is a bug or an issue with the template, but it different from 1.2.0. In attempting to render interfaces, the "description" field is now missing in the table list of properties.

Before

Screen Shot 2021-04-19 at 10 17 37 AM

Screen Shot 2021-04-19 at 10 17 20 AM

After

Screen Shot 2021-04-19 at 10 18 19 AM

Screen Shot 2021-04-19 at 10 18 11 AM

bigtimebuddy commented 3 years ago

Curious that this will show up in the Description column:

    /**
     * If the instance is paused, if the sound or global context
     * is paused, this could still be false.
     */
    paused: boolean;

But this doesn't

    /**  If the instance is paused, if the sound or global context is paused, this could still be false. */
    paused: boolean;
ShukantPal commented 3 years ago

Hmm, I think this is because the first line is now correctly going into the brief. Probably need to fix the template to include the brief in the summary table as well.

ShukantPal commented 3 years ago

Yup, if the first line isn't continued by the second line - it goes into the document's brief instead of the description. This is so that you can show a smaller description in the summary tables (in @webdoc/default-template).

bigtimebuddy commented 3 years ago

Hmm, this is not exactly what I'd expect

ShukantPal commented 3 years ago

The idea comes from JavaDoc.