Although i didn't really compare JSDoc to it, YUIDoc is an alternative for documentation and it's worth a look at it. YUIDoc is also useful for non YUI code.
see here: http://developer.yahoo.com/yui/yuidoc/ I didn't run your code to be honest. Maybe you can "jslint" your code to raise quality if you already haven't done that. Jan On Aug 19, 3:26 am, Philip Schweiger <[email protected]> wrote: > Hi, > > I recently posted a small library on github that is a wrapper around > the Facebook JavaScript SDK. I'm calling it FSW, for Facebook > JavaScript Wrapper. > > https://github.com/anyonecancode/FSW > > It's an attempt to address some of the more painful aspects I've found > in developing for Facebook - contradictory documentation, inconsistent > interfaces, and lack of versioning. > > This is an early release, so it only wraps around the FB features I've > had to use frequently, but I hope to continue developing FSW and > adding more features. If anyone has time and inclination, especially > anyone who's had to work with the FB SDK, I'd appreciate feedback. I'm > especially looking for feedback around the following: > > - ease of use. My main impetus for the wrapper is to make it easier to > interact with Facebook, so meeting this is the most basic pass/fail > point. > > - quality of the code. I'm using the module pattern, but I would > probably classify myself only as an intermediate JS developer, so if > I'm missing out on some obvious best practices, I'd like to hear it. > > - documentation tips. I only recently discovered jsdoc-toolkit, which > I'm using to generate the documentation. > > - Reducing dependencies. The wrapper requires jQuery (tested on > 1.6.2); if possible I'd like to eliminate that dependency. Doing DOM > selection without jQuery wouldn't be so much of a problem, but I am > also using jQuery to load the official Facebook SDK and fire a ready > event when that's loaded; I'd love to learn about alternatives. I did > try an earlier version of this using require.js, which is nice, but > ideally I wouldn't have any dependencies on outside libraries (beyond > the Facebook library, of course). > > Thanks! > > Philip Schweiger -- To view archived discussions from the original JSMentors Mailman list: http://www.mail-archive.com/[email protected]/ To search via a non-Google archive, visit here: http://www.mail-archive.com/[email protected]/ To unsubscribe from this group, send email to [email protected]
