Re: [libstdc++] Doxygen markup for algorithms

[Phil Edwards <phil at jaj dot com>]

On Mon, Feb 11, 2002 at 10:34:48AM +0000, Jonathan Wakely wrote:
> Reading the text of the proposal am I right in thinking it can modify the
> argument so long as it doesn't change anything that would affect the
> ordering of the sequence?

Pretty much.  If elements 1, 2, 3, and 4 go in, then all four must come out,
and in the same order.  Only their contents may have changed.


> Should there be a doxygen group for "non-modifying sequence operations"
> that describes the common features of for_each, find_if etc. ?

That sounds good.  We should probably also have a group for all algorithms.
Then the individual functions can either A) be listed as members of both,
or B) the documentation block for the "non-modifying sequence operations"
group should include itself in the larger algorithms group.  I don't know
which way produces better-looking docs.  :-)


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