lep / jassdoc

Document the WarCraft 3 API
52 stars 20 forks source link

Doc for Summon events and getters #133

Closed Luashine closed 5 months ago

Luashine commented 5 months ago

https://github.com/Luashine/wc3-test-maps/tree/master/GetSummonedUnit

Hey lep, I was not sure where to put the per-event descriptions for the getters. I chose and think it's better to put what getters to use under event constants, because there's only one event but many different getters. It's easier for editing due to the one-to-many relationship rather than many-to-many if I were to put the comment to each getter. But for usability like in IDE it'd be better to mirror relevant lines to the getter function descriptions, like when exporting or showing this.