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

Add section for "Inherited Events" #279

Open
joshtynjala opened this issue Jan 27, 2021 · 4 comments
Open

Add section for "Inherited Events" #279

joshtynjala opened this issue Jan 27, 2021 · 4 comments

Comments

@joshtynjala
Copy link

Similar to "Inherited Variables" and "Inherited Methods", the end of each page should also include "Inherited Events" for the @event tag content from base classes. Basically, it'll be just as convenient as the others.

Mockup:
inherited-events-mockup

@Simn
Copy link
Member

Simn commented Jan 28, 2021

This is a bit of a strategic question... Haxe doesn't know what events are, and Dox being a Haxe documentation generation tool suggests to me that it shouldn't know what events are either.

My initial approach would be to allow configuration of how items are grouped, but this sounds like a more involved effort.

@joshtynjala
Copy link
Author

I really hope you won't remove support for @event from dox.

@Simn
Copy link
Member

Simn commented Jan 31, 2021

I'm not sure how we went from "please support it" to "please don't remove it", but no I don't plan to remove support for anything.

@joshtynjala
Copy link
Author

I'm not sure how we went from "please support it" to "please don't remove it"

Your previous comment:

Haxe doesn't know what events are, and Dox being a Haxe documentation generation tool suggests to me that it shouldn't know what events are either.

Dox already knows about events. With that in mind, the quote above makes it sound like you want to remove what already exists.

This feature request is to expand the existing @event feature. You already display events on a class in a nice table. I'd also like to see inherited events on subclasses of that class.

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

No branches or pull requests

2 participants