Boost C++ Libraries: Ticket #8496: Signals2 "reference" documentation inadequate https://svn.boost.org/trac10/ticket/8496 <p> 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. </p> <p> A particular point: the <code>signal.hpp</code> listing shows no methods of a <code>signal</code>. One needs to browse into <code>signal.hpp</code>, then to <code>preprocessed_signal.hpp</code>, and then to <code>detail/signal_tempate.hpp</code>, and then search for "connect(" or similar, to actually find the methods of a signal. </p> <p> I've been using signals for a couple of years, and I only just discovered that the <code>connect()</code> method (1) takes a <code>const&amp;slot</code>, rather than just a <code>slot</code>, and (2) has a second <code>position</code> argument with a default value. I knew from reading other documentation that there is a connect_extended() method, but no examples of use, requiring me to once again delve down into source that is supposed to not be important to the end user -- that's why it's in DETAIL. </p> <p> The same issues pertain with <code>connection</code> and <code>slot</code>. </p> <p> Further, I am opposed to alphabetical organization of classes. Order them by importance: <code>signal</code>, <code>slot</code>, <code>connection</code> should be first. </p> <p> I'm only setting this bug's severity to "cosmetic" because the other documentation bugs I've found have that setting. </p> en-us Boost C++ Libraries /htdocs/site/boost.png https://svn.boost.org/trac10/ticket/8496 Trac 1.4.3 viboes Tue, 30 Apr 2013 22:55:00 GMT component changed; owner set https://svn.boost.org/trac10/ticket/8496#comment:1 https://svn.boost.org/trac10/ticket/8496#comment:1 <ul> <li><strong>owner</strong> set to <span class="trac-author">Frank Mori Hess</span> </li> <li><strong>component</strong> <span class="trac-field-old">None</span> → <span class="trac-field-new">signals2</span> </li> </ul> Ticket fmh6jj@… Wed, 01 May 2013 14:51:13 GMT <link>https://svn.boost.org/trac10/ticket/8496#comment:2 </link> <guid isPermaLink="false">https://svn.boost.org/trac10/ticket/8496#comment:2</guid> <description> <p> Replying to <a class="closed ticket" href="https://svn.boost.org/trac10/ticket/8496" title="#8496: Bugs: Signals2 &#34;reference&#34; documentation inadequate (closed: invalid)">Mike Cowperthwaite &lt;michael.cowperthwaite@…&gt;</a>: </p> <blockquote class="citation"> <p> 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. </p> <p> A particular point: the <code>signal.hpp</code> listing shows no methods of a <code>signal</code>. One needs to browse into <code>signal.hpp</code>, then to <code>preprocessed_signal.hpp</code>, and then to <code>detail/signal_tempate.hpp</code>, and then search for "connect(" or similar, to actually find the methods of a signal. </p> </blockquote> <p> No, you don't need to do that. See: </p> <p> <a href="http://www.boost.org/doc/libs/1_53_0/doc/html/boost/signals2/signal.html">http://www.boost.org/doc/libs/1_53_0/doc/html/boost/signals2/signal.html</a> </p> <p> It's a little unintuitive to find the proper link from the reference page, but that's an issue with boostbook. </p> </description> <category>Ticket</category> </item> <item> <dc:creator>Frank Mori Hess</dc:creator> <pubDate>Sun, 28 Jul 2013 01:06:20 GMT</pubDate> <title>status changed; resolution set https://svn.boost.org/trac10/ticket/8496#comment:3 https://svn.boost.org/trac10/ticket/8496#comment:3 <ul> <li><strong>status</strong> <span class="trac-field-old">new</span> → <span class="trac-field-new">closed</span> </li> <li><strong>resolution</strong> → <span class="trac-field-new">invalid</span> </li> </ul> <p> No further response from submitter, closing. </p> Ticket