[CF-Devel] Code documentation? Warnings cleaning?

crossfire-devel at archives.real-time.com crossfire-devel at archives.real-time.com
Sat Nov 15 19:25:55 CST 2003


Nicolas Weeger wrote:
>
     
      Hello.
     
     >
     
     
     >
     
      I was wondering if some documentation for the code was generated. Tools 
     
     >
     
      like doxygen are pretty useful, but i don't know if we use something or 
     
     >
     
      not?
     
     >
     
      I'm not saying the code isn't clear, just that it could be worth doing 
     
     >
     
      some (inline) documentation :)
     
     
  Additional comments is never bad.  It's just that generally, most developers 
have 'better' things to do than go through the code and write comments (at 
minimum, I'd say there are some sections of code that work, but which are really 
ugly and could be rewritten as a higher priority than writing comments).

  If there are specific questions about code, I'd hope people working on it 
would just ask - given the amount of code, a lot of work to document it all. 
However, if people need specific areas documented because they are working on 
it, something can be done.

>
     
     
     >
     
      Also, I'd like to clean warnings on server code. Windows compilation 
     
     >
     
      under Visual Studio produces a whole lot of warnings (around 500), most 
     
     >
     
      are I think harmless and could be fixed right away (like using 3.0 for 
     
     >
     
      initialisation of a constant instead of 3.0f), but some may just say 
     
     >
     
      there's something wrong. Arguably, Windows gives more errors than gcc, 
     
     >
     
      so maybe I won't try to clean everything, but other things may well be 
     
     >
     
      worth cleaning, imo.
     
     >
     
      Of course, if I fix many things, I may just break something.... While 
     
     >
     
      I'll take the uttermost precaution when fixing, some apparently minor 
     
     >
     
      changes may have bad side effects...
     
     >
     
      Any objections? Comments?
     
     
  I'd like to ge a better idea of the nature of all those compiles.  Perhaps an 
error log can be posted someplace?

  I'm a little concerned in that some of these could break compiling on unix. 
Eg, different API for windows or whatever else.  It'd be a shame for you to fix 
all those, and then have them undone because it breaks it working on unix.

  Also, there are some number of errors that just can't be fixed/eliminated. 
Anything from loader.c, or the other .c files which are generated from .l files 
really can't be fixed.  This is because it is code that lex generates which is 
resulting in the warnings.   So having those files produce warnings is just a 
fact of life.



_______________________________________________
crossfire-devel mailing list
     
     crossfire-devel at lists.real-time.com
     
     
     https://mailman.real-time.com/mailman/listinfo/crossfire-devel
     
     
    


More information about the crossfire mailing list