cordova-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Jesse <purplecabb...@gmail.com>
Subject Re: JavaScript comment tags in FileSystem plugin distort, www/*.js: What tool are they designed for?
Date Tue, 03 Feb 2015 02:11:31 GMT
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 <agrieve@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 <jmalin@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
> > jmalin@exou.com
> >
>

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message