08-22-2012, 07:12 PM
For those who haven't noticed, I have managed to cobble together a doxygen config file that generates the doxygen documentation from the MCServer sources. This is especially useful for viewing the class hierarchy or some base overview of the code.
It would be immensely helpful if all the devs could add comments to newly written code, at least to the major functions, documenting what the code does. I've been doing something like that for some time, should you need an example.
This is even more useful for functions that are virtual and there are descendants overriding those functions. Interface definitions are a must. If there's ever a need to make yet another descendant, it's vital that we know what each virtual function does exactly. See the cChunkGenerator.h file for an example.
I know that writing docs is boring and noone likes to do that, but it's the stuff that helps the most in the long run. Please try to do it at least a little bit.
It would be immensely helpful if all the devs could add comments to newly written code, at least to the major functions, documenting what the code does. I've been doing something like that for some time, should you need an example.
This is even more useful for functions that are virtual and there are descendants overriding those functions. Interface definitions are a must. If there's ever a need to make yet another descendant, it's vital that we know what each virtual function does exactly. See the cChunkGenerator.h file for an example.
I know that writing docs is boring and noone likes to do that, but it's the stuff that helps the most in the long run. Please try to do it at least a little bit.