support using types declared in JSDoc comments about deno_doc HOT 5 OPEN

This is an odd bug.
Can you share your code, and is this on deno.land/x and if so, does it render the same or is it correct there?

from deno_doc.

I'm having the same Issues.

Additionally it also ignores JSDoc typedefinitions.
Something like:

/**
 * @typedef  {Object}    input          - An input
 * @property {number[]}  input.string - Example prop
 * @property {number}    input.num - Example prop
 */

/**
 * To decode the uplink data
 * @access private
 * @param   {input}     input - The object to decode
 * @returns {output}          - The decoded object
 */
function decode(input) {
 ...
}

is not included in the HTML output.

from deno_doc.

This i an odd bug. Can you share your code, and is this on deno.land/x and if so, does it render the same or is it correct there?

I do not publish on deno.land/x, thus I do not know if it also occurs on it.

I edited my issue to add a link to my repository: https://gitlab.com/libshare/pwa

After a pull, calling deno doc --html public/object/media.js should provide the doc with the bug described.

TypeScript documentation seems to be generated with the types in it, I suppose the {type} info from doc comments is not correctly parsed. With TypeScript it is probably taking the real type directly. Example from deno note seems to work as expected on TypeScript example from deno

from deno_doc.

I created a new repository with only one JavaScript file, with a function and a class in it, with JSDoc comments.

I host it on both Gitlab and Github, and attached a hook to deno.land/x.
it is in order to answer with as many info as possible your question @crowlKats :

This i an odd bug. Can you share your code, and is this on deno.land/x and if so, does it render the same or is it correct there?

As an answer, it seems neither the local deno doc --html nor deno.land handle the JSDoc {type}.

I hope I did it correctly for the hook, it's my first time.

Here are links for you to check:

• gitlab repository
• the locally generated HTML JSDoc, with deno doc --html
  • the full command for the deno doc is in deno.json, task: doc
• github repository
• deno land /x

from deno_doc.

Sorry to dig up an old-ish issue, but I'm having the same problem with constructor parameters intermittently. I'll try to throw together a repro as soon as I can.

from deno_doc.