[Boost-bugs] [Boost C++ Libraries] #6952: [interprocess] mixed comment styles causing documentation issues?

Subject: [Boost-bugs] [Boost C++ Libraries] #6952: [interprocess] mixed comment styles causing documentation issues?
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2012-05-29 15:43:03

#6952: [interprocess] mixed comment styles causing documentation issues?
--------------------------------------+-------------------------------------
 Reporter:  anthony.foiani@…          |       Owner:  igaztanaga  
     Type:  Bugs                      |      Status:  new         
Milestone:  To Be Determined          |   Component:  interprocess
  Version:  Boost 1.49.0              |    Severity:  Cosmetic    
 Keywords:                            |  
--------------------------------------+-------------------------------------
 There are a handful of comments of the form:


 {{{
   //! ... */
 }}}


 In at least one instance (boost/interprocess/ipc/message_queue.hpp), the
 code looks like this:


 {{{
    //!Sends a message stored in buffer "buffer" with size "buffer_size" in
 the
    //!message queue with priority "priority". If the message queue is full
    //!the sender is blocked. Throws interprocess_error on error.*/
    void send (const void *buffer,     size_type buffer_size,
               unsigned int priority);
 }}}


 Which got rendered into the docs like so:

    *void send(const void * buffer, size_type buffer_size, unsigned int
 priority);

    Sends a message stored in buffer "buffer" with size "buffer_size" in
    the message queue with priority "priority". If the message queue is
    full the sender is blocked. Throws interprocess_error on error.

    --
 http://www.boost.org/doc/libs/1_49_0/doc/html/boost/interprocess/message_queue_t.html#id985430-bb


 Note the leading "*" on the method signature.

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