The problem with this is that then inline functions do not get documented at all. Although most inline functions are obvious what they do, there have been instances where I needed to understand what an inline function did and then had to start rooting through source files - often, not because the function itself was complicated, but because the change it made had effects elsewhere in the class that weren't obvious (to me). I'm not sure what a good solution to this would be as I take your point about comments in the header files - the re-compiles would be very annoying and the header would be fairly unreadable. Though of course, in the case of inline functions, changing the implementation necessitates a re-compile. Matt On Monday 05 August 2002 12:51 pm, you wrote: >JDoc makes the header files totally unreadable with all the comments. I >strongly prefer the comments in the source file. Also every change in >the implementation would force a change in the header to update the >comments and trigger complete recompiles. That is why we made THtml and >the source comments as they are. It would be nice if doxygen could be >made to understand the current ROOT doc style (description + first >consecutive comment field at the beginning of each method.
This archive was generated by hypermail 2b29 : Sat Jan 04 2003 - 23:51:03 MET