Re: [glob2-devel] Release

[Bradley Arsenault]

On 1/18/07, Kai Antweiler <address@hidden> wrote:
> > It is very critical, however, that the new code is well documented.
> > This is sort of a new rule, all new code must be well documented.
>
> > We use doxygen. You can read up on doxygen on its website.
>
> No, we should not enforce doxygen.
> We can suggest to use it - but insisting on it would be wrong.
> Our workforce is too small to put up additional obstacles.
> It doesn't matter that doxygen is not difficult to use.
> Most amateur programmers I know even shy away from version control
> systems or Makefiles.
>
> The normal "//"-comments in the code (even in broken english) must be
> enough!
>
>
> By the way:
> I have never used doxygen.  Is it really favorable?
> The only code documentation tool I ever used was cweb.
> And I was very disappointed.
>
> --
> Kai Antweiler
>
>
> _______________________________________________
> glob2-devel mailing list
> address@hidden
> http://lists.nongnu.org/mailman/listinfo/glob2-devel
Making doxygen comments is trivial. there is only two things to remember:

1) Add comments before the line being commented (etc class, function definition)
2) Use ///, not //, doyxgen detects ///

Doxygen does an very good job of doing the rest, organizing
everything, generating html, etc...
--
Whats long and hard and filled with seamen? My submarine!  -  Bradley Arsenault