[boost] Another Signals doc tweak

From: David Abrahams (dave_at_[hidden])
Date: 2002-10-30 11:50:35

The docs show this constructor:

   explicit signal(const Combiner& = Combiner(), const GroupCompare& = GroupCompare());

I think it should say:

   explicit signal(Combiner = Combiner(), GroupCompare = GroupCompare());

Even though that's not the actual signature in the library, since
these objects will be copied (a convention that is used in the
standard also). This brings up an interesting point about the
difference between user and implementation documentation. If we are
using an automatic documentation extraction tool like Synopsis, we
should be able to tell the tool that const& arguments should be
represented as values in the user docs. For example,

   explicit signal(
        const Combiner& = Combiner() // @copied
        , const GroupCompare& = GroupCompare() // @copied
   );

-Dave

-- 
                    David Abrahams
dave_at_[hidden] * http://www.boost-consulting.com