search

coffeedoc / codo

CoffeeScript API documentation generator. It's like YARD but for CoffeeScript!
Other
624 stars 92 forks source link

Include method/function source in documentation #199

Open jasonl99 opened 9 years ago

jasonl99 commented 9 years ago

I think it would be useful to include the source of each method (minus the documentation that has already been extracted) in an initially-collapsed element. I've tried to look at the code and figure out how to do this, but it's way over my head :).

There'd be a "Show Source" button that would toggle visibility, and show something like this:

version: ->
    JSON.parse(
      FS.readFileSync(Path.join(__dirname, '..', 'package.json'), 'utf-8')
    )['version']
waissbluth commented 9 years ago

I support this; it would be extremely useful. This was proposed three years ago here #16