Re: [Boost-bugs] [Boost C++ Libraries] #8496: Signals2 "reference" documentation inadequate

Subject: Re: [Boost-bugs] [Boost C++ Libraries] #8496: Signals2 "reference" documentation inadequate
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2013-05-01 14:51:13

#8496: Signals2 "reference" documentation inadequate
---------------------------------------------------------------------------+
  Reporter:  Mike Cowperthwaite <michael.cowperthwaite@…>                  |       Owner:  fmhess  
      Type:  Bugs                                                          |      Status:  new     
 Milestone:  To Be Determined                                              |   Component:  signals2
   Version:  Boost 1.52.0                                                  |    Severity:  Cosmetic
Resolution:                                                                |    Keywords:          
---------------------------------------------------------------------------+

Comment (by fmh6jj@…):

 Replying to [ticket:8496 Mike Cowperthwaite <michael.cowperthwaite@…>]:
 > The reference page for Signals2 does not provide enough information. I
 shouldn't have to to browse the source in order to discover basic details
 of the classes in this library.
 >
 > A particular point: the `signal.hpp` listing shows no methods of a
 `signal`.  One needs to browse into `signal.hpp`, then to
 `preprocessed_signal.hpp`, and then to `detail/signal_tempate.hpp`, and
 then search for "connect(" or similar, to actually find the methods of a
 signal.

 No, you don't need to do that.  See:

 http://www.boost.org/doc/libs/1_53_0/doc/html/boost/signals2/signal.html


 It's a little unintuitive to find the proper link from the reference page,
 but that's an issue with boostbook.

-- 
Ticket URL: <https://svn.boost.org/trac/boost/ticket/8496#comment:2>
Boost C++ Libraries <http://www.boost.org/>
Boost provides free peer-reviewed portable C++ source libraries.