coffeedoc / codo

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

Link to mixin method fails to parse correctly #237

Closed CodeLenny closed 8 years ago

CodeLenny commented 8 years ago

A link to a mixin method in the body of a comment ({MyMixin#foo}) fails to parse at all, and prints the full string including brackets. An @see link points to class/MyMixin#foo rather than mixins/MyMixin#foo, which fails to load.

###
My Mixin
@mixin
###
MyMixin:
  foo: (bar) -> console.log bar
###
How about seeing {MyMixin#foo}?
@see MyMixin#foo
class MyClass
  constructor: -> @foo()
inossidabile commented 8 years ago

That's because you aren't using the correct notation. The methods of Modules aren't static nor dynamic. We are using the ~ sign to refer those. So if you change it to MyMixin~foo things will roll.

CodeLenny commented 8 years ago

Gotcha, thank you! That makes my documentation much cleaner.