Follow-up Comment #2, patch #1137 (project wesnoth):
I've reviewed your patch and some remarks
please use doxygen comments for the run_file_function class so it shows up at
http://devdocs.wesnoth.org
I understand we confused you with the hardcoded or not problem and you didn't
know what to do. So we need to discuss that first so you can 'fix' your TODOs.
Boucman left some comment in the irc log of 22th of March starting at 11:01.
read_stream is static in filesystem.cpp since it's not in declared in
filesystem.hpp. Since you use it once and it's rather trivial you can add the
code to the main function or declare it in filesystems.hpp and remove the
static in filesystem.cpp so you can use it in your patch.
Finding the proper balance between what to comment and what not is hard to
find. Most of the Wesnoth code has too little comment; you added a bit too
much and too little at the same time.
Too much means commenting the obvious eg line 66 //was unable to open
specified file. It's obvious there was a problem opening the file from line
65.
Too little is not commenting the code in header files formula_ai.hpp. Please
add some doxygen comment in the header file.
Also have a look at your variables and add const when appropriate.
_______________________________________________________
Reply to this item at:
<http://gna.org/patch/?1137>
_______________________________________________
Message sent via/by Gna!
http://gna.org/
_______________________________________________
Wesnoth-bugs mailing list
[email protected]
https://mail.gna.org/listinfo/wesnoth-bugs
