JSDoc {Array<Byte>}

[kwpsd]

Version: 6.0.6 - build 1232

I am attempting to JSDoc a method to send e-mail and have trouble with the 'attachment' parameter:

Code: Select all

/**
  * <stuff>
  *
  * @param {Array<Byte>} attachment File attachment
  *
  * <more stuff>
  *
  */

The parameter is being flagged as a warning of 'Unknown type Byte', however, the JSDoc section of the Wiki shows this example for '@param' et al:

{Array<Byte>} An array containing just bytes

What notation should I be using?

[ptalbot]

How about:

Code: Select all

@param {byte[]} attachment

or if all else fails

Code: Select all

@param attachment

[jasantana]

Try:

@param {Array<byte>}

Byte must be lowercase.

[kwpsd]

Ah, <Byte> should be <byte>...got it! Thank you, gentlemen.

Servoy...the wiki should be upated, so that others do not fall into the same trap.