[CF-Devel] Code documentation? Warnings cleaning?

[crossfire-devel at archives.real-time.com]

'lo

>
     
       Seems to be Ok.  I've only briefly looked at doxygen, and their 
     
     >
     
      suggested commenting style - I don't see anything terribly wrong with 
     
     >
     
      it, but at the same time, be aware that I wouldn't expect (nor require) 
     
     >
     
      that style to be followed by everyone.  Eg, I'll personally just 
     
     >
     
      continue to do comments in the form I'm used to.
     
     
Comments like:
/**
  * this
  */

can be extracted automatically. Seems close enough to what is used in CF :)
Of course if you want to start putting brief comments & full comments, it's 
slightly different.

Of course you can do many other formats, if you want the full list check 
     
     http://www.stack.nl/~dimitri/doxygen/docblocks.html
     
     
And yes it can extract javadoc style comments.

No, I don't expect everyone to follow, fine by me :)

>
     
       Everyone should also be aware that sourceforge offers a compile farm 
     
     >
     
      for its developers, so even if you don't have linux/whatever access, you 
     
     >
     
      can use the compile farm to test compliance.  Only problem is that you 
     
     >
     
      then need to get your changes there somehow.
     
     
Forgot the compile farm, haven't actually used it at all ^.^
But I think Knoppix, maybe with some virtual machine if i'm too lazy to reboot, 
will do the trick (that's what Knoppix is for, after all, no need to install :))
(will be faster for code transfer, maybe)

Nicolas 'Ryo'


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