search

coffeedoc / codo

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

Suggested feature: @inheritdoc tag #203

Closed jusopi closed 8 years ago

jusopi commented 9 years ago

One of the tedious tasks of making API docs is having to make sure that overridden APIs in subclasses have the same docs text found in their super classes. It would be nice to have some sort of lookup feature that when the parsers sees the @inheritdoc string, it will try to find the original API docs text in the super class and build from there. An example of this can be found in the asdocs generator for Flash/Actionscript

  class Base

       #
       # A method
       #
       foo: -> 

   class Subbase extends Base

       #
       # @inheritdoc
       #
       foo: ->
            super
inossidabile commented 8 years ago

I'm not sure it's gonna be too useful in Coffee reality. However I will accept PR if you prepare one.