search

coffeedoc / codo

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

Doesn't work with Ember.js projects #182

Closed amk221 closed 10 years ago

amk221 commented 10 years ago

I'm working on an Ember-cli project

# My controller
# @example
#   Blah
MyController = Ember.Controller.extend
  # My property
  # @return {String}
  myProperty: (-> 'blah').property()

However the above is never noticed by codo.

levibuzolic commented 10 years ago

@amk221 take a look at my hacky workaround in #183 -- not great, but at least you get some output.

It seems that codo has issues with the someVariable = Library.creationFunction pattern.

inossidabile commented 10 years ago

This is not an idiomatic Coffee class. Codo is meant to support Coffee-Script not all the "classish" extensions every new framework adds to javascript. And it will not no matter how popular the framework is.

The main reason for that is that "class" in Coffee-Script is a term. And what you are trying to name "class" is an expression. The term is static. The expression is dynamic. Dynamic expression can not and should not be documented this way. Please take a look at Literate Coffee Script instead.

luketheobscure commented 9 years ago

Every few weeks I come back and look at this comment and get really sad for a while.

inossidabile commented 9 years ago

@luketheobscure the new Codo has pretty extensible structure that you can inherit and override. Fork it, change the way it seeks for classes and you are done.