JSDoc types

[kurideja]

I was wondering about types/constructors. Here you suggest {String} as type definition for a string parameter. The original JSDoc seems to use lowercase type names for scalars and uppercase constructor names for Objects or Arrays.

Is there any particular reason you define string with constructor name (String) rather than its type (string)?

[johnpapa]

nope ... in fact, id love to see some guidelines with some code setup isntructions on how to use jdoc in this issue to help folks use it with the guide. interested in helping contribute that and adjusting the guide with a PR for any changes needed?

[kurideja]

Will look into it next week ;)

[johnpapa]

looking forward to this!

[Nazanin1369]

Is there anyone working on this? otherwise I would like to enhance the JSDoc section.

[kurideja]

@Nazanin1369 , I got extremely busy after opening the ticket. Feel free to work on this.

[Nazanin1369]

@kurideja sure.

[Nazanin1369]

@johnpapa removed the descriptions in last commit. Do we want to include an example from ngdoc also?

[sukrosono]

IMO it will be clear with an example 😄