cordova-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Joe Malin <>
Subject JavaScript comment tags in FileSystem plugin distort, www/*.js: What tool are they designed for?
Date Mon, 02 Feb 2015 21:27:33 GMT

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!


Joe Malin
Senior Technical Writer
EXO U, Inc.
Palo Alto, CA, USA
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message