Noted. Would it make sense to submit the comments I’ve done. I have them working in JSDoc, and it would be simple for me to set them up so they work in YUIdoc as well.
Joe ---- Joe Malin Senior Technical Writer EXO U, Inc. Palo Alto, CA, USA jma...@exou.com -----Original Message----- From: Jesse Reply-To: dev Date: Monday, February 2, 2015 at 18:11:00 GMT-08:00 To: dev Subject: Re: JavaScript comment tags in FileSystem plugin distort, www/*.js: What tool are they designed for? >They are informational, the only docs we 'own' for the file api. >Supposedly they were based on the original File-API spec[1], which is why >you see DOMString as a type. > >[1] http://dev.w3.org/2006/webapi/FileAPI/ > >@purplecabbage >risingj.com > >On Mon, Feb 2, 2015 at 6:02 PM, Andrew Grieve <agri...@chromium.org> >wrote: > >> I'm fairly certain that they've never been run through a tool :S >> >> On Mon, Feb 2, 2015 at 4:27 PM, Joe Malin <jma...@exou.com> wrote: >> >> > Greetings! >> > >> > I’m looking at the JavaScript libraries distributed in the FileSystem >> > plugin, org.apache.cordova.file, www/*.js, such as FileEntry.js. They >> > contain comments and @ tag descriptors. What tool are they aimed at? >>They >> > don’t seem to be for YUIdoc, since most of them don’t contain the >> required >> > header tags. They’re not exactly compatible with JSdoc either; they >>use >> > @constructor instead of @constructs (although I’m not sure that this >>is >> > important), and they refer to the unknown type DOMString. >> > >> > Of course, I’ve never seen reference docs for FileSystem, so this may >>be >> > the reason! >> > >> > Regards, >> > >> > Joe >> > ---- >> > Joe Malin >> > Senior Technical Writer >> > EXO U, Inc. >> > Palo Alto, CA, USA >> > jma...@exou.com >> > >>
