netzpirat/codo — Issue #25: functions internal to the class closure are found and documented.
Author: Squeegy
Created: 2012-02-27 20:18:30+00:00
State: open

class Foo
# This is not exposed to the outside world.
internalToClassClosure = -> alert 'internal!'

# A normal instance method.
bar: -> internalToClassClosure

**codo** will document `internalToClassClosure` as a method, even though it really isn't. And it's extra weird, because the comments attached to it appear not to be parsed and it's documented as a naked method with no description or markup. It's also reported as an instance method, which isn't technically right at all.

Is the intent to document functions like this? Personally, It's even more private than `@private` since other internal classes do not have access to it. So I would say it doesn't belong in the docs even with `--private`. If, however, you disagree then there is definitely a bug with the doc being parsed for functions declared like this.