[Feature Request] Improve JSDocs

TensorFlow.js version

"@tensorflow/tfjs-node": "^1.4.0" but it also happens with previous releases.

Describe the problem or feature request

Currently the declaration preview (hovering over a method) is not very informative. For example, hovering over dot method I get the following info Same happens with auto complete feature:

Because of this, I constantly have to check the API available at https://js.tensorflow.org/api/latest/ Which is completely fine but having docs directly in my editor would be much better.

I’ve looked at actual exports_layers.ts file and the description of the dot method is declared there.

The problem is that the description is declared in a separate blocks. So vscode ignores the /** docs */ block and only shows the /** @doc {} */

/** docs */
/** @doc {heading: 'Layers', subheading: 'Merge', namespace: 'layers'} */
export declare function dot(args: DotLayerArgs): Layer;

Merging two blocks into one

/** docs 
  *   @doc {heading: 'Layers', subheading: 'Merge', namespace: 'layers'} */
export declare function dot(args: DotLayerArgs): Layer;

creates a much better experience as I have all the info directly in my code editor

Is this something that you can do?

[archie-swif]

Here’s a PR for it: https://github.com/tensorflow/tfjs/pull/3780

[tafsiri]

this will be available in the next release.