JSDoc annotations

[smalluban]

Based on the documentation we should add JSDoc annotations to the source code, or typescript definitions to add additional descriptions to the autocompletion features of the IDEs.

[Qsppl]

If you just need to duplicate the documentation in JSDOC, then I can do it tomorrow

[smalluban]

We can start with that. It should be done in typescript definitions. We can add short description params and return values. You can try using a few basic APIs to confirm if this is the way we want to go (so as not to waste your time).

[Qsppl]

Ok, I will open a Pull Request and perform part of the work this evening.

[Qsppl]

The documentation and the API Reference have minor differences. Do I have to fix it?

Example

https://hybrids.js.org/#/misc/api-reference?id=definition

component - an object with map of hybrid property descriptors with a tag name set to tag property

https://hybrids.js.org/#/component-model/definition?id=single-component

component - an object with map of property descriptors with a tag name set in the tag property

[Qsppl]

I wrote an example in #286.

Please take a look before I continue.

[smalluban]

We can unify them. Usually, the API reference is out of date. Use the main documents as a source of truth.

The example in PR looks very cool!