You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Is there a link to a complete documentation for how to document code compatible with dox?
I miss specially how to document functions that takes a variable number of arguments, and arguments that accept any types. I saw JSDoc uses {...Type} for the former and {*} for the latter, maybe it's something like {...*} for an argument with variable number of arguments of all types.
How would you document a function that takes a string as the first argument, and a callback as the last, and any number of arguments of any type in between?
Also, how to document an argument that can be of e.g. Object or String types and be omitted or set to null? In JSDoc I see something like {?Object|String} or @param {Object|String} [arg].
Thanks in advance.
The text was updated successfully, but these errors were encountered:
Is there a link to a complete documentation for how to document code compatible with dox?
I miss specially how to document functions that takes a variable number of arguments, and arguments that accept any types. I saw JSDoc uses
{...Type}
for the former and{*}
for the latter, maybe it's something like{...*}
for an argument with variable number of arguments of all types.How would you document a function that takes a string as the first argument, and a callback as the last, and any number of arguments of any type in between?
Also, how to document an argument that can be of e.g. Object or String types and be omitted or set to null? In JSDoc I see something like
{?Object|String}
or@param {Object|String} [arg]
.Thanks in advance.
The text was updated successfully, but these errors were encountered: