coffeedoc / codo

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

Result type is not referenced. #153

Closed 5c077yP closed 10 years ago

5c077yP commented 10 years ago

Hey,

the reference to known classes/methods doesn't work for the @return type. It works perfectly in the @return description or in class descriptions.

ex.:

###
  This is my {TestClass}
###
class TestClass
  ###
    It creates one instance of {TestClass}.
  ###
  constructor: ->

###
   A {SecondTestClass}.
###
class SecondTestClass
  ###
    Creates an instance of {SecondTestClass}.
  ###
  constructor: (testClass) ->
    @t1 = testClass

  ###
    Returns the internal {TestClass} instance.
    @return [TestClass] The internal {TestClass} instance.
  ###
  getTestClass: -> @t1

Maybe i am wrong, but i thought the @return [TestClass] ... will generate a link to the TestClass documentation?

Btw. I'm using codo@2.0.6.

Thanks.