This is the mail archive of the
libstdc++@gcc.gnu.org
mailing list for the libstdc++ project.
Re: doxygen comments for stl_algo.h
I'll send you some editorial comments privately in a moment, but...
On Tue, Feb 05, 2002 at 02:01:53AM +0000, Jonathan Wakely wrote:
> That's about 20% of the file covered, so I'd like to get feedback on
> whether what I'm writing is suitable, particularly for search, which is
> quite a complicated algorithm to explain without being too vague or too
> technical (I thought so anyway)
...this is great.
> Are the comments too technical? Too much [first1, last1 - last2 + first2)
> techno-babble for the users who'll be referring to it? Or not technical
> enough?
> I think they're ok, but I've just been immersed in the standard and
> references to write them, so might have lost perspective!
We take pains elsewhere to explain the whole "half-open range" idea, so
I think we should make use of the expressiveness that [first,last) offers us.
> If these comments are suitable I will finish the rest of the file and
> submit a patch for the whole thing (with changelog etc.)
Go for it. The changelog will be pretty simple ("file: doxygenate"
or whatever), but for something this big we probably ought to get you a
copyright assignment form soon, if you're willing. I asked the FSF for
help yesterday but they're the slowest organization I've ever dealt with.
Phil
--
If ye love wealth greater than liberty, the tranquility of servitude greater
than the animating contest for freedom, go home and leave us in peace. We seek
not your counsel, nor your arms. Crouch down and lick the hand that feeds you;
and may posterity forget that ye were our countrymen. - Samuel Adams