Fabien Costantini wrote:
> > I hope we won't regret not to have centralized all doc in one place,  
> > now that we deal with both H and CXX.

matthiasm wrote:
> I am aware that this is a compromise. I too hope that we will be fine.  
> At least we have a defined place, the implementation of whatever is  
> documented. It was argued that keeping the docs close to the  
> implementation will make it easier to keep them in sync. It is not  
> what I do in my projects, but it seems like a strong argument.

IMHO, the key thing is that the documentation moves from the separate
html files (that may or may not be updated with the code) into a format
that allows automatic generation and that lives beside the code (and
has a better chance of being kept up to date).

In the first instance, whether it is in both .H and .cxx files or just
in the .H files is irrelevant. The hard work will be to do the conversion.
After that, we can cut'n'paste the doxygen comments back and forth
between .H and .cxx as required.

As Abraham Lincoln said: "you can please all of the people some of the
time, some of the people all of the time, but you can't please all of
the people all of the time". Or something like that.

Cheers
Duncan

_______________________________________________
fltk-dev mailing list
[email protected]
http://lists.easysw.com/mailman/listinfo/fltk-dev

Reply via email to