Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

So about those constants #2

Open
MSP-Greg opened this issue Apr 17, 2016 · 2 comments
Open

So about those constants #2

MSP-Greg opened this issue Apr 17, 2016 · 2 comments

Comments

@MSP-Greg
Copy link

Will they be added?

One could probably could add another 'list' to the list groups ( Classes | Methods | Constants | Files )...

I don't know if you've got them removed from the YARD output in the templates or in the registry...

@thomthom
Copy link
Member

Not for the initial release. There's some work to get them all listed. Once thing is that many of the constants are defined with C macros in our code - so we need to make YARD pick them up.

Then there is the issue of how they are formatted. YARD seem to want a description per constant. In many cases that's redundant as it makes more sense to describe them in groups.

I wanted to bring back the class grouping which the existing docs have. Looked into adding custom pages - though deferring until we got the foundation in order.

@MSP-Greg
Copy link
Author

You're probably aware, YARD will doc constants on a class / module level, but in the previous API doc's many are doc'd in methods.

I wanted to bring back the class grouping which the existing docs have. Looked into adding custom pages - though deferring until we got the foundation in order.

I assume you're referring to the left side tree / menu, like in --

Sketchup Ruby API Documentation

That would require some thought as to where and how you wanted it shown...

As a side note, YARD only sorts methods by name, not by name + namespace. That's a one line code fix (I've got it in yard-t2). See the 'add' methods.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants