search

coffeedoc / codo

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

Add @namespace for manual namespacing. #208

Closed rstone770 closed 8 years ago

rstone770 commented 9 years ago

Hello,

I'd like to add an extra tag that would allow people to override the automatic namespace detection. I normally use folder hierarchy to namespace my projects but would still like to have the namespace hierarchy view in the generated documents.

# inside storage/entities
#
# @namespace Storage.Entities
#
class SomeClass

There is also an issue in this PR that needs to be addressed. If the namespace is overridden, should the class name appear as the basename + classname as it does before the parsing, or should the basename be trimmed off as it is now?

Thank you for your time and this kick ass tool.

fixed spelling.

rstone770 commented 9 years ago

The failing test is not related to any changes I made. It looks like its been failing for some time.

dbartholomae commented 8 years ago

@rstone770 My PR which fixes the bug in codo was accepted, so an updated PR should now pass the build test.

rstone770 commented 8 years ago

PR branch has been rebased.

inossidabile commented 8 years ago

Awesome, thanks!

inossidabile commented 8 years ago

Regarding the aforementioned issue: I don't see why should there be difference in how we display namespace whether it's manual or not