Add Related
complete
Voltaism
Add related functions and events under the function/event we are browsing.
Eg :
GetHealth
Related : SetHealth, OnHealthChange
Would be blue stuff that we could click on.
If we are looking at a function, related functions could be generated next to it so we can find faster what we want.
Could be implemented as a related.json file in the api that would contain all the groups {‘GetHealth’, ‘SetHealth’, ‘OnHealthChange’}
Because adding this in each function and event would ´duplicate ´ parts of the groups and lead to mistakes by the end.
And related could also reference functions outside of a class.
To implement this you could have a dynamic programming approach, when searching for one function in the groups, tag each one you found with both indexes in a table and store where you last stopped in your search to have the faster thing.
This implementation would also be useful to make a powerful game test bench as a script could generate some tests automatically with it.
GTNardy
complete
T
Timmy
This is a great idea! Would this be only to make search easier or also to add it next to methods/events/... in the class/struct/... pages?
The only downside that I see (if it's added to pages) is that it'd probably make classes/structs/... pages way longer, and thus make them look messy
Voltaism
Timmy: it would be under the function / event name
A small line with related stuff that we can click on (hyperlinks)
Won’t make the pages really bigger
Could also be used to put functions related to each other closer so when you are looking to SetHealth there would be GetHealth under it
T
Timmy
Voltaism: I agree that this could be a good addition if it's not something that stands out too much, like a small gray text under the function names
Not sure if the whole idea would be easy to add with docusaurus tho