Opened 10 years ago

#6952 new Bugs

[interprocess] mixed comment styles causing documentation issues?

Reported by: anthony.foiani@… Owned by: Ion Gaztañaga
Milestone: To Be Determined Component: interprocess
Version: Boost 1.49.0 Severity: Cosmetic
Keywords: Cc:

Description

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.

Attachments (1)

0001-Fix-mixed-comment-style-that-might-be-confusing-doc-.patch (19.8 KB ) - added by anthony.foiani@… 10 years ago.
patch to fix mixed-style comments

Download all attachments as: .zip

Change History (1)

by anthony.foiani@…, 10 years ago

patch to fix mixed-style comments

Note: See TracTickets for help on using tickets.