On Wed, Aug 15, 2007 at 11:57:00AM +0200, Hans-Joachim Gurt wrote: > >make a wiki page with some info on .. Doxygen > > Ok, I can write up some bits about it.
Yes please and maybe include the link in Doxygen and also make a link from coding style. > >you had a question why certain info wasn't included in Doxygen. > >I just used the previous settings. .. If you feel there should > >be changes to these settings feel free to do so. > > I also would like some feedback while updating the doxygen-config > and the comments in the code, to maximize the usefulness. > > Also, there are some style-issues I would like to talk about: > * I prefer "//!" and "@param" over "/**", "///" and "\param", > because it is easier to search for "! " and " @". > * I prefer the detailed doc-strings in the cpp-file, because there > will be the most work done, and thus more convincent to read. I don't have a strong opinion, I based my style on builder.cpp. I only would like to see a consitient style, but the amount of documentation we have at the moment should be easily rewritten in a new style. I also think there aren't much other developers who use the Doxygen comment. I'm about to cleanup the preferences files but wait for the new Doxygen style, then I directly add the documentation in those files in the proper style. > By(t)e, > HaJo Gurt Regards, Mark de Wever aka Mordante/SkeletonCrew _______________________________________________ Wesnoth-dev mailing list [email protected] https://mail.gna.org/listinfo/wesnoth-dev
