-
From d1c8283ccb240b277bea9e1be6b99fa2c25f6772 Mon Sep 17 00:00:00 2001
From: Anthony Foiani <anthony.foiani@gmail.com>
Date: Tue, 29 May 2012 09:26:57 -0600
Subject: [PATCH] Fix mixed comment style that might be confusing doc
generator.
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.
Signed-Off-By: Anthony Foiani <anthony.foiani@gmail.com>
---
boost/interprocess/detail/managed_memory_impl.hpp | 8 ++++----
boost/interprocess/indexes/iset_index.hpp | 2 +-
boost/interprocess/ipc/message_queue.hpp | 4 ++--
boost/interprocess/managed_external_buffer.hpp | 2 +-
boost/interprocess/managed_heap_memory.hpp | 2 +-
boost/interprocess/managed_shared_memory.hpp | 2 +-
boost/interprocess/managed_xsi_shared_memory.hpp | 2 +-
boost/interprocess/mem_algo/simple_seq_fit.hpp | 2 +-
boost/interprocess/segment_manager.hpp | 2 +-
boost/interprocess/shared_memory_object.hpp | 2 +-
boost/interprocess/sync/interprocess_semaphore.hpp | 2 +-
.../sync/interprocess_upgradable_mutex.hpp | 2 +-
boost/interprocess/sync/named_condition.hpp | 2 +-
boost/interprocess/sync/scoped_lock.hpp | 8 ++++----
boost/interprocess/sync/sharable_lock.hpp | 4 ++--
boost/interprocess/sync/shm/named_condition.hpp | 2 +-
.../interprocess/sync/windows/named_condition.hpp | 2 +-
libs/container/test/heap_allocator_v1.hpp | 2 +-
libs/interprocess/doc/interprocess.qbk | 2 +-
libs/interprocess/test/allocator_v1.hpp | 2 +-
libs/interprocess/test/heap_allocator_v1.hpp | 2 +-
21 files changed, 29 insertions(+), 29 deletions(-)
diff --git a/boost/interprocess/detail/managed_memory_impl.hpp b/boost/interprocess/detail/managed_memory_impl.hpp
index f9ecb8a..0d10669 100644
a
|
b
|
struct segment_manager_type
|
60 | 60 | //!achieve this, this class uses the reserved space provided by the allocation |
61 | 61 | //!algorithm to place a named_allocator_algo, who takes care of name mappings. |
62 | 62 | //!The class can be customized with the char type used for object names |
63 | | //!and the memory allocation algorithm to be used.*/ |
| 63 | //!and the memory allocation algorithm to be used. |
64 | 64 | template < class CharType |
65 | 65 | , class MemoryAlgorithm |
66 | 66 | , template<class IndexConfig> class IndexType |
… |
… |
class basic_managed_memory_impl
|
265 | 265 | } |
266 | 266 | |
267 | 267 | //!Transforms previously obtained offset into an absolute address in the |
268 | | //!process space of the current process. Never throws.*/ |
| 268 | //!process space of the current process. Never throws. |
269 | 269 | void * get_address_from_handle (handle_t offset) const |
270 | 270 | { return reinterpret_cast<char*>(this->get_address()) + offset; } |
271 | 271 | |
… |
… |
class basic_managed_memory_impl
|
483 | 483 | //!-> If T's constructor throws, the function throws that exception. |
484 | 484 | //! |
485 | 485 | //!Memory is freed automatically if T's constructor throws and |
486 | | //!destructors of created objects are called before freeing the memory.*/ |
| 486 | //!destructors of created objects are called before freeing the memory. |
487 | 487 | template <class T> |
488 | 488 | typename segment_manager::template construct_iter_proxy<T>::type |
489 | 489 | construct_it(char_ptr_holder_t name, std::nothrow_t nothrow) |
… |
… |
class basic_managed_memory_impl
|
506 | 506 | //!-> If T's constructor throws, the function throws that exception. |
507 | 507 | //! |
508 | 508 | //!Memory is freed automatically if T's constructor throws and |
509 | | //!destructors of created objects are called before freeing the memory.*/ |
| 509 | //!destructors of created objects are called before freeing the memory. |
510 | 510 | template <class T> |
511 | 511 | typename segment_manager::template construct_iter_proxy<T>::type |
512 | 512 | find_or_construct_it(char_ptr_holder_t name, std::nothrow_t nothrow) |
-
diff --git a/boost/interprocess/indexes/iset_index.hpp b/boost/interprocess/indexes/iset_index.hpp
index 8fc9146..175ccd7 100644
a
|
b
|
struct iset_index_aux
|
56 | 56 | |
57 | 57 | //!Index type based in boost::intrusive::set. |
58 | 58 | //!Just derives from boost::intrusive::set |
59 | | //!and defines the interface needed by managed memory segments*/ |
| 59 | //!and defines the interface needed by managed memory segments |
60 | 60 | template <class MapConfig> |
61 | 61 | class iset_index |
62 | 62 | //Derive class from map specialization |
-
diff --git a/boost/interprocess/ipc/message_queue.hpp b/boost/interprocess/ipc/message_queue.hpp
index 67dd574..67512c0 100644
a
|
b
|
class message_queue_t
|
99 | 99 | |
100 | 100 | //!Sends a message stored in buffer "buffer" with size "buffer_size" in the |
101 | 101 | //!message queue with priority "priority". If the message queue is full |
102 | | //!the sender is blocked. Throws interprocess_error on error.*/ |
| 102 | //!the sender is blocked. Throws interprocess_error on error. |
103 | 103 | void send (const void *buffer, size_type buffer_size, |
104 | 104 | unsigned int priority); |
105 | 105 | |
… |
… |
class mq_hdr_t
|
269 | 269 | //!Constructor. This object must be constructed in the beginning of the |
270 | 270 | //!shared memory of the size returned by the function "get_mem_size". |
271 | 271 | //!This constructor initializes the needed resources and creates |
272 | | //!the internal structures like the priority index. This can throw.*/ |
| 272 | //!the internal structures like the priority index. This can throw. |
273 | 273 | mq_hdr_t(size_type max_num_msg, size_type max_msg_size) |
274 | 274 | : m_max_num_msg(max_num_msg), |
275 | 275 | m_max_msg_size(max_msg_size), |
-
diff --git a/boost/interprocess/managed_external_buffer.hpp b/boost/interprocess/managed_external_buffer.hpp
index e268e57..25d57fa 100644
a
|
b
|
namespace interprocess {
|
35 | 35 | |
36 | 36 | //!A basic user memory named object creation class. Inherits all |
37 | 37 | //!basic functionality from |
38 | | //!basic_managed_memory_impl<CharType, AllocationAlgorithm, IndexType>*/ |
| 38 | //!basic_managed_memory_impl<CharType, AllocationAlgorithm, IndexType> |
39 | 39 | template |
40 | 40 | < |
41 | 41 | class CharType, |
-
diff --git a/boost/interprocess/managed_heap_memory.hpp b/boost/interprocess/managed_heap_memory.hpp
index 8710785..1778585 100644
a
|
b
|
namespace interprocess {
|
36 | 36 | |
37 | 37 | //!A basic heap memory named object creation class. Initializes the |
38 | 38 | //!heap memory segment. Inherits all basic functionality from |
39 | | //!basic_managed_memory_impl<CharType, AllocationAlgorithm, IndexType>*/ |
| 39 | //!basic_managed_memory_impl<CharType, AllocationAlgorithm, IndexType> |
40 | 40 | template |
41 | 41 | < |
42 | 42 | class CharType, |
-
diff --git a/boost/interprocess/managed_shared_memory.hpp b/boost/interprocess/managed_shared_memory.hpp
index 4bed5b5..f673a6f 100644
a
|
b
|
namespace interprocess {
|
34 | 34 | |
35 | 35 | //!A basic shared memory named object creation class. Initializes the |
36 | 36 | //!shared memory segment. Inherits all basic functionality from |
37 | | //!basic_managed_memory_impl<CharType, AllocationAlgorithm, IndexType>*/ |
| 37 | //!basic_managed_memory_impl<CharType, AllocationAlgorithm, IndexType> |
38 | 38 | template |
39 | 39 | < |
40 | 40 | class CharType, |
-
diff --git a/boost/interprocess/managed_xsi_shared_memory.hpp b/boost/interprocess/managed_xsi_shared_memory.hpp
index dc909f6..f893ff3 100644
a
|
b
|
namespace interprocess {
|
38 | 38 | |
39 | 39 | //!A basic X/Open System Interface (XSI) shared memory named object creation class. Initializes the |
40 | 40 | //!shared memory segment. Inherits all basic functionality from |
41 | | //!basic_managed_memory_impl<CharType, AllocationAlgorithm, IndexType>*/ |
| 41 | //!basic_managed_memory_impl<CharType, AllocationAlgorithm, IndexType> |
42 | 42 | template |
43 | 43 | < |
44 | 44 | class CharType, |
-
diff --git a/boost/interprocess/mem_algo/simple_seq_fit.hpp b/boost/interprocess/mem_algo/simple_seq_fit.hpp
index 1085ca0..a4d4ab1 100644
a
|
b
|
class simple_seq_fit
|
43 | 43 | |
44 | 44 | //!Constructor. "size" is the total size of the managed memory segment, |
45 | 45 | //!"extra_hdr_bytes" indicates the extra bytes beginning in the sizeof(simple_seq_fit) |
46 | | //!offset that the allocator should not use at all.*/ |
| 46 | //!offset that the allocator should not use at all. |
47 | 47 | simple_seq_fit (size_type size, size_type extra_hdr_bytes) |
48 | 48 | : base_t(size, extra_hdr_bytes){} |
49 | 49 | }; |
-
diff --git a/boost/interprocess/segment_manager.hpp b/boost/interprocess/segment_manager.hpp
index 8680a95..1ad5a27 100644
a
|
b
|
class segment_manager
|
499 | 499 | |
500 | 500 | //!Calls object function blocking recursive interprocess_mutex and guarantees that |
501 | 501 | //!no new named_alloc or destroy will be executed by any process while |
502 | | //!executing the object function call*/ |
| 502 | //!executing the object function call |
503 | 503 | template <class Func> |
504 | 504 | void atomic_func(Func &f) |
505 | 505 | { scoped_lock<rmutex> guard(m_header); f(); } |
-
diff --git a/boost/interprocess/shared_memory_object.hpp b/boost/interprocess/shared_memory_object.hpp
index f3bc7ba..b1a7261 100644
a
|
b
|
class shared_memory_object
|
61 | 61 | shared_memory_object(); |
62 | 62 | |
63 | 63 | //!Creates a shared memory object with name "name" and mode "mode", with the access mode "mode" |
64 | | //!If the file previously exists, throws an error.*/ |
| 64 | //!If the file previously exists, throws an error. |
65 | 65 | shared_memory_object(create_only_t, const char *name, mode_t mode, const permissions &perm = permissions()) |
66 | 66 | { this->priv_open_or_create(ipcdetail::DoCreate, name, mode, perm); } |
67 | 67 | |
-
diff --git a/boost/interprocess/sync/interprocess_semaphore.hpp b/boost/interprocess/sync/interprocess_semaphore.hpp
index 2a2f34f..969f2b9 100644
a
|
b
|
class interprocess_semaphore
|
56 | 56 | /// @endcond |
57 | 57 | public: |
58 | 58 | //!Creates a interprocess_semaphore with the given initial count. |
59 | | //!interprocess_exception if there is an error.*/ |
| 59 | //!interprocess_exception if there is an error. |
60 | 60 | interprocess_semaphore(unsigned int initialCount); |
61 | 61 | |
62 | 62 | //!Destroys the interprocess_semaphore. |
-
diff --git a/boost/interprocess/sync/interprocess_upgradable_mutex.hpp b/boost/interprocess/sync/interprocess_upgradable_mutex.hpp
index 8d5a452..2785eea 100644
a
|
b
|
class interprocess_upgradable_mutex
|
176 | 176 | //! fail if there are threads with sharable ownership or timeout reaches, but it |
177 | 177 | //! will maintain upgradable ownership. |
178 | 178 | //!Returns: If acquires exclusive ownership, returns true. Otherwise returns false. |
179 | | //!Throws: An exception derived from interprocess_exception on error. */ |
| 179 | //!Throws: An exception derived from interprocess_exception on error. |
180 | 180 | bool timed_unlock_upgradable_and_lock(const boost::posix_time::ptime &abs_time); |
181 | 181 | |
182 | 182 | //!Precondition: The thread must have sharable ownership of the mutex. |
-
diff --git a/boost/interprocess/sync/named_condition.hpp b/boost/interprocess/sync/named_condition.hpp
index ca0205a..9e7848c 100644
a
|
b
|
class named_condition
|
77 | 77 | ~named_condition(); |
78 | 78 | |
79 | 79 | //!If there is a thread waiting on *this, change that |
80 | | //!thread's state to ready. Otherwise there is no effect.*/ |
| 80 | //!thread's state to ready. Otherwise there is no effect. |
81 | 81 | void notify_one(); |
82 | 82 | |
83 | 83 | //!Change the state of all threads waiting on *this to ready. |
-
diff --git a/boost/interprocess/sync/scoped_lock.hpp b/boost/interprocess/sync/scoped_lock.hpp
index 61fe93e..7fb68c3 100644
a
|
b
|
class scoped_lock
|
245 | 245 | } |
246 | 246 | |
247 | 247 | //!Effects: if (owns()) mp_mutex->unlock(). |
248 | | //!Notes: The destructor behavior ensures that the mutex lock is not leaked.*/ |
| 248 | //!Notes: The destructor behavior ensures that the mutex lock is not leaked. |
249 | 249 | ~scoped_lock() |
250 | 250 | { |
251 | 251 | try{ if(m_locked && mp_mutex) mp_mutex->unlock(); } |
… |
… |
class scoped_lock
|
286 | 286 | //!Notes: The scoped_lock changes from a state of not owning the mutex, to |
287 | 287 | //! owning the mutex, but only if blocking was not required. If the |
288 | 288 | //! mutex_type does not support try_lock(), this function will fail at |
289 | | //! compile time if instantiated, but otherwise have no effect.*/ |
| 289 | //! compile time if instantiated, but otherwise have no effect. |
290 | 290 | bool try_lock() |
291 | 291 | { |
292 | 292 | if(!mp_mutex || m_locked) |
… |
… |
class scoped_lock
|
301 | 301 | //!Notes: The scoped_lock changes from a state of not owning the mutex, to |
302 | 302 | //! owning the mutex, but only if it can obtain ownership by the specified |
303 | 303 | //! time. If the mutex_type does not support timed_lock (), this function |
304 | | //! will fail at compile time if instantiated, but otherwise have no effect.*/ |
| 304 | //! will fail at compile time if instantiated, but otherwise have no effect. |
305 | 305 | bool timed_lock(const boost::posix_time::ptime& abs_time) |
306 | 306 | { |
307 | 307 | if(!mp_mutex || m_locked) |
… |
… |
class scoped_lock
|
314 | 314 | //! exception. Calls unlock() on the referenced mutex. |
315 | 315 | //!Postconditions: owns() == false. |
316 | 316 | //!Notes: The scoped_lock changes from a state of owning the mutex, to not |
317 | | //! owning the mutex.*/ |
| 317 | //! owning the mutex. |
318 | 318 | void unlock() |
319 | 319 | { |
320 | 320 | if(!mp_mutex || !m_locked) |
-
diff --git a/boost/interprocess/sync/sharable_lock.hpp b/boost/interprocess/sync/sharable_lock.hpp
index 9342e45..9b5cec8 100644
a
|
b
|
namespace interprocess {
|
45 | 45 | //!the Mutex does not supply, no harm is done. Mutex ownership can be shared among |
46 | 46 | //!sharable_locks, and a single upgradable_lock. sharable_lock does not support |
47 | 47 | //!copy semantics. But sharable_lock supports ownership transfer from an sharable_lock, |
48 | | //!upgradable_lock and scoped_lock via transfer_lock syntax.*/ |
| 48 | //!upgradable_lock and scoped_lock via transfer_lock syntax. |
49 | 49 | template <class SharableMutex> |
50 | 50 | class sharable_lock |
51 | 51 | { |
… |
… |
class sharable_lock
|
136 | 136 | //!Notes: If upgr is locked, this constructor will lock this sharable_lock while |
137 | 137 | //! unlocking upgr. Only a moved sharable_lock's will match this |
138 | 138 | //! signature. An non-moved upgradable_lock can be moved with the expression: |
139 | | //! "boost::move(lock);".*/ |
| 139 | //! "boost::move(lock);". |
140 | 140 | template<class T> |
141 | 141 | sharable_lock(BOOST_RV_REF(upgradable_lock<T>) upgr |
142 | 142 | , typename ipcdetail::enable_if< ipcdetail::is_same<T, SharableMutex> >::type * = 0) |
-
diff --git a/boost/interprocess/sync/shm/named_condition.hpp b/boost/interprocess/sync/shm/named_condition.hpp
index 9d7cd77..dee9c20 100644
a
|
b
|
class shm_named_condition
|
83 | 83 | ~shm_named_condition(); |
84 | 84 | |
85 | 85 | //!If there is a thread waiting on *this, change that |
86 | | //!thread's state to ready. Otherwise there is no effect.*/ |
| 86 | //!thread's state to ready. Otherwise there is no effect. |
87 | 87 | void notify_one(); |
88 | 88 | |
89 | 89 | //!Change the state of all threads waiting on *this to ready. |
-
diff --git a/boost/interprocess/sync/windows/named_condition.hpp b/boost/interprocess/sync/windows/named_condition.hpp
index f718610..cb24672 100644
a
|
b
|
class windows_named_condition
|
49 | 49 | ~windows_named_condition(); |
50 | 50 | |
51 | 51 | //!If there is a thread waiting on *this, change that |
52 | | //!thread's state to ready. Otherwise there is no effect.*/ |
| 52 | //!thread's state to ready. Otherwise there is no effect. |
53 | 53 | void notify_one(); |
54 | 54 | |
55 | 55 | //!Change the state of all threads waiting on *this to ready. |
-
diff --git a/libs/container/test/heap_allocator_v1.hpp b/libs/container/test/heap_allocator_v1.hpp
index 56fc1a2..9a04259 100644
a
|
b
|
namespace test {
|
41 | 41 | //!An STL compatible heap_allocator_v1 that uses a segment manager as |
42 | 42 | //!memory source. The internal pointer type will of the same type (raw, smart) as |
43 | 43 | //!"typename SegmentManager::void_pointer" type. This allows |
44 | | //!placing the heap_allocator_v1 in shared memory, memory mapped-files, etc...*/ |
| 44 | //!placing the heap_allocator_v1 in shared memory, memory mapped-files, etc... |
45 | 45 | template<class T, class SegmentManager> |
46 | 46 | class heap_allocator_v1 |
47 | 47 | { |
-
diff --git a/libs/interprocess/doc/interprocess.qbk b/libs/interprocess/doc/interprocess.qbk
index 73f9b48..dbcc985 100644
a
|
b
|
defines the following types:
|
3088 | 3088 | //!and offset_ptr as internal pointers) as memory allocation algorithm |
3089 | 3089 | //!and the default index type as the index. |
3090 | 3090 | //!This class allows the shared memory to be mapped in different base |
3091 | | //!in different processes*/ |
| 3091 | //!in different processes |
3092 | 3092 | typedef basic_managed_shared_memory |
3093 | 3093 | <char |
3094 | 3094 | ,/*Default memory algorithm defining void * as void_pointer*/ |
-
diff --git a/libs/interprocess/test/allocator_v1.hpp b/libs/interprocess/test/allocator_v1.hpp
index d833c26..292e318 100644
a
|
b
|
namespace test {
|
41 | 41 | //!An STL compatible allocator_v1 that uses a segment manager as |
42 | 42 | //!memory source. The internal pointer type will of the same type (raw, smart) as |
43 | 43 | //!"typename SegmentManager::void_pointer" type. This allows |
44 | | //!placing the allocator_v1 in shared memory, memory mapped-files, etc...*/ |
| 44 | //!placing the allocator_v1 in shared memory, memory mapped-files, etc... |
45 | 45 | template<class T, class SegmentManager> |
46 | 46 | class allocator_v1 |
47 | 47 | { |
-
diff --git a/libs/interprocess/test/heap_allocator_v1.hpp b/libs/interprocess/test/heap_allocator_v1.hpp
index d5b8bac..033ded0 100644
a
|
b
|
namespace test {
|
41 | 41 | //!An STL compatible heap_allocator_v1 that uses a segment manager as |
42 | 42 | //!memory source. The internal pointer type will of the same type (raw, smart) as |
43 | 43 | //!"typename SegmentManager::void_pointer" type. This allows |
44 | | //!placing the heap_allocator_v1 in shared memory, memory mapped-files, etc...*/ |
| 44 | //!placing the heap_allocator_v1 in shared memory, memory mapped-files, etc... |
45 | 45 | template<class T, class SegmentManager> |
46 | 46 | class heap_allocator_v1 |
47 | 47 | { |