Add more documentation

[12xx12]

There is a bunch of documentation outdated or missing:

• world.ini
• stuff in the prefab files (flags, ...)
  • cPieceModifier interface and cPieceModifierRandomizeBlocks class #5122

There would be some more stuff to do - this is just a late at night issue

[tonitch]

I posted it on discord but here it might stand the test of time ^^

I was wondering if documenting more methods wouldn't be a good thing ? I'm coming from a world of java where pretty much everything is over-documented which is quite handy for new-comers to contribute!

When I'm starting to get into a new project I like to make small comment in file where I strugled to understand what a method would do so when I come on this method again I don't have to do the same process...

Would it be in the project philosophy to let me push these comments when I have good explanation of what a method would do for everyone else to enjoy?

I know the downside is that documentation can get old but I prefer old doc than no-doc (personal opinion)

This would be cool to have a doxygen instance up to date too!

and finally! If you think this is a good idea, I think a line about that should be added in the CONTRIBUTE.md with a documentation syntax (for doxygen compatibility https://www.doxygen.nl/manual/docblocks.html)