Lighthouse has a new layout. Prefer the old one? Return to the old layout, and switch back any time from the link at the top of each page.

Add JSDoc style inline comments

#31

We need to add JSDoc style inline comments to each method.

Reported by John-David Dalton · July 3rd, 2009 @ 08:33 PM

State: new
Milestone: none
Assigned to: Joe Gornick Joe Gornick

Activity

  1. Kit Goncharov
    Kit Goncharov
    • State changed from new to open

    Since Fuse is a Prototype-based library, why not just use PDoc? (http://pdoc.org) Of course, PDoc is a Ruby library, so that might conflict with us moving away from Ruby and toward a Rhino-based solution...

    Out of interest, what are the advantages to using Rhino over Ruby for building and dependency management?

    July 7th, 2009 @ 07:46 PM

  2. Joe Gornick
    Joe Gornick

    A while ago, I created a documentation branch which contains some basic array and enumerable documentation.

    Keep in mind, this is from Feb 01, 2009 so a lot has changed :)

    Here's a link to the documentation branch: https://github.com/jgornick/fusejs/tree/documentation

    There was only one commit to it (Start of inline....) and I would like to kill the remote branch once docs have been ported, if any.

    Here's direct links to the files changed:
    array.js - https://github.com/jgornick/fusejs/blob/a1f8c6e9a6f05ae603b82db4408...
    enumerable.js - https://github.com/jgornick/fusejs/blob/a1f8c6e9a6f05ae603b82db4408...

    Also, from looking and trying other documentation generators, I tend to like jsdoc-toolkit the best. Plus there's an ANT task for it :)

    August 29th, 2009 @ 01:21 AM

  3. John-David Dalton
  4. Joe Gornick
    Joe Gornick
    • Milestone cleared.
    • Assigned user changed from John-David Dalton to Joe Gornick
    • Milestone order changed from 0 to 0

    September 29th, 2010 @ 09:42 AM

  5. Joe Gornick
    Joe Gornick
    • State changed from open to new

    February 21st, 2011 @ 04:39 PM

Please Sign in or create a free account to add a new ticket.

With your very own profile, you can contribute to projects, track your activity, watch tickets, receive and update tickets through your email and much more.