Doxygen update and warning fixes #6954
Conversation
| @@ -256,8 +256,8 @@ DEF_CONSOLE_CMD(ConResetTile) | |||
|
|
|||
| /** | |||
| * Scroll to a tile on the map. | |||
| * @param arg1 tile tile number or tile x coordinate. | |||
| * @param arg2 optionally tile y coordinate. | |||
| * param x tile number or tile x coordinate. | |||
There was a problem hiding this comment.
I don't think this will generate right.
There was a problem hiding this comment.
The trouble with the console commands is that they don't actually have "proper" parameters - once the #define expands, they have argc & argv, not whatever console commands actually take. Probably need a better way of documenting console commands generally, but I decided that was out of scope for what I was trying to do (fix warnings)
There was a problem hiding this comment.
I think it might work to use the @fn command to introduce the functions, and then you should be allowed to use @param as well. But it would still not match up with the C++ function signature if you document the "logical" parameters... yeah, not going to work.
LordAro
force-pushed
the
doxyfix
branch
2 times, most recently
from
4a7a4c1
to
96bfecc
Compare
Documentation fixes were found by going through the output of
doxygen, ignoring missing documentation warnings. Nearly all fixed, but some left that aren't clear how to be fixed (usually related to attributes being referred to before they're declared? Maybe the explicit#could be removed)Split off from #6948 , with previous comments addressed