Re: [sigc] Documentation issues

[Murray Cumming <murrayc murrayc com>]

On Tue, 2007-05-15 at 09:41 +0200, Hans Meine wrote:
> Hi!
> 
> Talking about "no bugs" and "good documentation", I just want to point out 
> that my mail below still contains valid documentation errors that one can 
> stumble over.  (Yes, the docs are indeed quite good, and after finding out 
> how to implement marshallers properly I am still perfectly happy with 
> libsigc++.)

Patches are welcome. Please file separate bugs for issue that don't have
an obvious patch.

> Am Montag, 06. November 2006 16:48:59 schrieb Hans Meine:
> > I am just trying to use libsigc++, and I need the feature that each
> > pre-operation callback (slot) can cancel my operation by returning false.
> >
> > After looking at
> > http://libsigc.sourceforge.net/libsigc2/docs/manual/html/ch04s03.html
> > I implemented a mashaller, only to get an error about result_type.
> >
> > Now I already wondered about some design issues (OutType instead of
> > result_type, "marshaller" instead of "accumulator" etc.), which I then
> > realized were fixed, as can be seen in the reference documentation (which I
> > had to look at, since signal<void, my_arg_t, marshaller> was also an
> > obsolete, non-working syntax):
> > http://libsigc.sourceforge.net/libsigc2/docs/reference/html/classsigc_1_1si
> >gnal_1_1accumulated.html
> >
> > Indeed, that page even contains an "interruptable_accumulator" which is
> > exactly what I need.  However, there is another (small) glitch: The for
> > loop tries to increment n_ (C&P error from above).
> >
> > Hopefully someone finds the time to update the docs, apart from that
> > libsigc++ seems to be quite neat (and the tutorial-style-docs are very
> > helpful nevertheless!).  Now I hope the runtime (per-call) performance is
> > not too far behind my old, ugly, virtual-method-hook-class-in-std::vector
> > solution...
> 
-- 
Murray Cumming
murrayc murrayc com
www.murrayc.com
www.openismus.com