Join GitHub today
GitHub is home to over 20 million developers working together to host and review code, manage projects, and build software together.
functions internal to the class closure are found and documented. #25
codo will document
Is the intent to document functions like this? Personally, It's even more private than
This comment has been minimized.
This comment has been minimized.Show comment Hide comment
This is definitely a bug and was not done intentional.
Codo has to do some preprocessing of the CoffeeScript file before parsing, because normal comments are simply stripped out by the CoffeeScript lexer and do not appear as tokens in the parser. So there is some logic that tries to figure out which comments are useful for codo and converts them to block comments. Just converting every comment is not possible, since it may break conditions and loop under some circumstances. I decided to make this ugly work around, because I do not like the block comment style for class/method documentation like CoffeeDoc does.
The CoffeeScript parse tree can be quite complex and every type of token arrangement must be explicit detected. This is the most confusing part of Codo. I underestimated the effort a lot and this is also the reason why some parts of the source code are quite ugly, I just ran out of time and I wanted to get a first version out to see if there are other devs around who are interested in making a great CoffeeScript API doc generator. I'm telling you this to say that I appreciate your feedback and code improvements a lot!