Opened 10 years ago
#6952 new Bugs
[interprocess] mixed comment styles causing documentation issues?
| Reported by: | 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)
Change History (1)
by , 10 years ago
| Attachment: | 0001-Fix-mixed-comment-style-that-might-be-confusing-doc-.patch added | 
|---|


patch to fix mixed-style comments