openrw
openrw copied to clipboard
rwengine
Opcode documentation convention
Recently, my PRs were being reviewed. They contained some changes to opcode documentation. So that brought up the discussion in irc. This is why I want to hear people thoughts about current situation and how this should be handled. Currently what we have is very weird formatting(in my opinion) and not very descriptive information about arguments or even opcode itself, broken tabulation, missing names (0412 for example), etc. There is been a leak of original names in GTA:SA mobile version, but @JayFoxRox brought a good point that they shouldn't be used due to legal stuff. Maybe they can be changed in some way, so it would be fine.
Maybe something like this: https://gist.github.com/ShFil119/646e8e00b693070806ce32e0eb9119c0
With some parser it can generate quite good documentation.
Can you elaborate @ShFil119, like demonstrate an opcode with that formatting that example isn't very clear to me. Also it seems to be missing args.
I would like to have inline comments alongside the opcode. Using Doxygen we could generate the opcode documentation without much trouble.
