JSDoc {Array<Byte>}

Questions, tips and tricks and techniques for scripting in Servoy

JSDoc {Array<Byte>}

Postby kwpsd » Sat Jun 30, 2012 3:10 am

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?
Kim W. Premuda
San Diego, CA USA
User avatar
kwpsd
 
Posts: 635
Joined: Sat Jul 28, 2007 6:59 pm
Location: San Diego, CA USA

Re: JSDoc {Array<Byte>}

Postby ptalbot » Sat Jun 30, 2012 7:09 am

How about:
Code: Select all
@param {byte[]} attachment

or if all else fails
Code: Select all
@param attachment
Patrick Talbot
Freelance - Open Source - Servoy Valued Professional
http://www.servoy-stuff.net
https://www.servoyforge.net
--------------------------------------------
Servoy 5.2.16 / 6.0.9 / 6.1.6 / 7.3.1
All OSes / Java 5 & 6 & 7
User avatar
ptalbot
 
Posts: 1616
Joined: Wed Mar 11, 2009 5:13 am
Location: Montreal, QC

Re: JSDoc {Array<Byte>}

Postby jasantana » Sat Jun 30, 2012 10:44 am

Try:

@param {Array<byte>}

Byte must be lowercase.
Best regards,
Juan Antonio Santana Medina
jasantana@nephos-solutions.co.uk
Servoy MVP 2015
Servoy 6.x - Servoy 7.x - Servoy 8.x - MySQL - PostgreSQL - Visual Foxpro 9
User avatar
jasantana
 
Posts: 555
Joined: Tue Aug 10, 2010 11:40 am
Location: Leeds - West Yorkshire - United Kingdom

Re: JSDoc {Array<Byte>}

Postby kwpsd » Sat Jun 30, 2012 9:27 pm

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.
Kim W. Premuda
San Diego, CA USA
User avatar
kwpsd
 
Posts: 635
Joined: Sat Jul 28, 2007 6:59 pm
Location: San Diego, CA USA


Return to Methods

Who is online

Users browsing this forum: No registered users and 1 guest

cron