Documentarion on AMD modules

coffeedoc / codo

CoffeeScript API documentation generator. It's like YARD but for CoffeeScript!

Other

624 stars 92 forks source link

Documentarion on AMD modules #170

Closed abiee closed 10 years ago

abiee commented 10 years ago

I don't know if is a real issue, but, how I can document my AMD modules? I mean, classes are documented without any issue, but files which are not defining any class, doco does not do anything, for example:

define [
  'modA'
], (ModA) ->
  'use strict'

  # Some documentation here
  #
  # @return ....
  ModA.foobar = ->
    # ...

inossidabile commented 10 years ago

Currently there's no way to do that. Unfortunately I'm also quite busy atm to implement this as a feature. Pull requests are welcome.