dox icon indicating copy to clipboard operation
dox copied to clipboard

Add section for "Inherited Events"

Open joshtynjala opened this issue 4 years ago • 4 comments

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

joshtynjala avatar Jan 27 '21 23:01 joshtynjala

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.

Simn avatar Jan 28 '21 06:01 Simn

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

joshtynjala avatar Jan 28 '21 17:01 joshtynjala

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.

Simn avatar Jan 31 '21 15:01 Simn

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.

joshtynjala avatar Feb 01 '21 17:02 joshtynjala