From d1c8283ccb240b277bea9e1be6b99fa2c25f6772 Mon Sep 17 00:00:00 2001 From: Anthony Foiani 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 --- 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/boost/interprocess/detail/managed_memory_impl.hpp +++ b/boost/interprocess/detail/managed_memory_impl.hpp @@ -60,7 +60,7 @@ struct segment_manager_type //!achieve this, this class uses the reserved space provided by the allocation //!algorithm to place a named_allocator_algo, who takes care of name mappings. //!The class can be customized with the char type used for object names -//!and the memory allocation algorithm to be used.*/ +//!and the memory allocation algorithm to be used. template < class CharType , class MemoryAlgorithm , template class IndexType @@ -265,7 +265,7 @@ class basic_managed_memory_impl } //!Transforms previously obtained offset into an absolute address in the - //!process space of the current process. Never throws.*/ + //!process space of the current process. Never throws. void * get_address_from_handle (handle_t offset) const { return reinterpret_cast(this->get_address()) + offset; } @@ -483,7 +483,7 @@ class basic_managed_memory_impl //!-> If T's constructor throws, the function throws that exception. //! //!Memory is freed automatically if T's constructor throws and - //!destructors of created objects are called before freeing the memory.*/ + //!destructors of created objects are called before freeing the memory. template typename segment_manager::template construct_iter_proxy::type construct_it(char_ptr_holder_t name, std::nothrow_t nothrow) @@ -506,7 +506,7 @@ class basic_managed_memory_impl //!-> If T's constructor throws, the function throws that exception. //! //!Memory is freed automatically if T's constructor throws and - //!destructors of created objects are called before freeing the memory.*/ + //!destructors of created objects are called before freeing the memory. template typename segment_manager::template construct_iter_proxy::type 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/boost/interprocess/indexes/iset_index.hpp +++ b/boost/interprocess/indexes/iset_index.hpp @@ -56,7 +56,7 @@ struct iset_index_aux //!Index type based in boost::intrusive::set. //!Just derives from boost::intrusive::set -//!and defines the interface needed by managed memory segments*/ +//!and defines the interface needed by managed memory segments template class iset_index //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/boost/interprocess/ipc/message_queue.hpp +++ b/boost/interprocess/ipc/message_queue.hpp @@ -99,7 +99,7 @@ class message_queue_t //!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.*/ + //!the sender is blocked. Throws interprocess_error on error. void send (const void *buffer, size_type buffer_size, unsigned int priority); @@ -269,7 +269,7 @@ class mq_hdr_t //!Constructor. This object must be constructed in the beginning of the //!shared memory of the size returned by the function "get_mem_size". //!This constructor initializes the needed resources and creates - //!the internal structures like the priority index. This can throw.*/ + //!the internal structures like the priority index. This can throw. mq_hdr_t(size_type max_num_msg, size_type max_msg_size) : m_max_num_msg(max_num_msg), 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/boost/interprocess/managed_external_buffer.hpp +++ b/boost/interprocess/managed_external_buffer.hpp @@ -35,7 +35,7 @@ namespace interprocess { //!A basic user memory named object creation class. Inherits all //!basic functionality from -//!basic_managed_memory_impl*/ +//!basic_managed_memory_impl template < class CharType, diff --git a/boost/interprocess/managed_heap_memory.hpp b/boost/interprocess/managed_heap_memory.hpp index 8710785..1778585 100644 --- a/boost/interprocess/managed_heap_memory.hpp +++ b/boost/interprocess/managed_heap_memory.hpp @@ -36,7 +36,7 @@ namespace interprocess { //!A basic heap memory named object creation class. Initializes the //!heap memory segment. Inherits all basic functionality from -//!basic_managed_memory_impl*/ +//!basic_managed_memory_impl template < class CharType, diff --git a/boost/interprocess/managed_shared_memory.hpp b/boost/interprocess/managed_shared_memory.hpp index 4bed5b5..f673a6f 100644 --- a/boost/interprocess/managed_shared_memory.hpp +++ b/boost/interprocess/managed_shared_memory.hpp @@ -34,7 +34,7 @@ namespace interprocess { //!A basic shared memory named object creation class. Initializes the //!shared memory segment. Inherits all basic functionality from -//!basic_managed_memory_impl*/ +//!basic_managed_memory_impl template < 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/boost/interprocess/managed_xsi_shared_memory.hpp +++ b/boost/interprocess/managed_xsi_shared_memory.hpp @@ -38,7 +38,7 @@ namespace interprocess { //!A basic X/Open System Interface (XSI) shared memory named object creation class. Initializes the //!shared memory segment. Inherits all basic functionality from -//!basic_managed_memory_impl*/ +//!basic_managed_memory_impl template < 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/boost/interprocess/mem_algo/simple_seq_fit.hpp +++ b/boost/interprocess/mem_algo/simple_seq_fit.hpp @@ -43,7 +43,7 @@ class simple_seq_fit //!Constructor. "size" is the total size of the managed memory segment, //!"extra_hdr_bytes" indicates the extra bytes beginning in the sizeof(simple_seq_fit) - //!offset that the allocator should not use at all.*/ + //!offset that the allocator should not use at all. simple_seq_fit (size_type size, size_type extra_hdr_bytes) : base_t(size, extra_hdr_bytes){} }; diff --git a/boost/interprocess/segment_manager.hpp b/boost/interprocess/segment_manager.hpp index 8680a95..1ad5a27 100644 --- a/boost/interprocess/segment_manager.hpp +++ b/boost/interprocess/segment_manager.hpp @@ -499,7 +499,7 @@ class segment_manager //!Calls object function blocking recursive interprocess_mutex and guarantees that //!no new named_alloc or destroy will be executed by any process while - //!executing the object function call*/ + //!executing the object function call template void atomic_func(Func &f) { scoped_lock 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/boost/interprocess/shared_memory_object.hpp +++ b/boost/interprocess/shared_memory_object.hpp @@ -61,7 +61,7 @@ class shared_memory_object shared_memory_object(); //!Creates a shared memory object with name "name" and mode "mode", with the access mode "mode" - //!If the file previously exists, throws an error.*/ + //!If the file previously exists, throws an error. shared_memory_object(create_only_t, const char *name, mode_t mode, const permissions &perm = permissions()) { this->priv_open_or_create(ipcdetail::DoCreate, name, mode, perm); } diff --git a/boost/interprocess/sync/interprocess_semaphore.hpp b/boost/interprocess/sync/interprocess_semaphore.hpp index 2a2f34f..969f2b9 100644 --- a/boost/interprocess/sync/interprocess_semaphore.hpp +++ b/boost/interprocess/sync/interprocess_semaphore.hpp @@ -56,7 +56,7 @@ class interprocess_semaphore /// @endcond public: //!Creates a interprocess_semaphore with the given initial count. - //!interprocess_exception if there is an error.*/ + //!interprocess_exception if there is an error. interprocess_semaphore(unsigned int initialCount); //!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/boost/interprocess/sync/interprocess_upgradable_mutex.hpp +++ b/boost/interprocess/sync/interprocess_upgradable_mutex.hpp @@ -176,7 +176,7 @@ class interprocess_upgradable_mutex //! fail if there are threads with sharable ownership or timeout reaches, but it //! will maintain upgradable ownership. //!Returns: If acquires exclusive ownership, returns true. Otherwise returns false. - //!Throws: An exception derived from interprocess_exception on error. */ + //!Throws: An exception derived from interprocess_exception on error. bool timed_unlock_upgradable_and_lock(const boost::posix_time::ptime &abs_time); //!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/boost/interprocess/sync/named_condition.hpp +++ b/boost/interprocess/sync/named_condition.hpp @@ -77,7 +77,7 @@ class named_condition ~named_condition(); //!If there is a thread waiting on *this, change that - //!thread's state to ready. Otherwise there is no effect.*/ + //!thread's state to ready. Otherwise there is no effect. void notify_one(); //!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/boost/interprocess/sync/scoped_lock.hpp +++ b/boost/interprocess/sync/scoped_lock.hpp @@ -245,7 +245,7 @@ class scoped_lock } //!Effects: if (owns()) mp_mutex->unlock(). - //!Notes: The destructor behavior ensures that the mutex lock is not leaked.*/ + //!Notes: The destructor behavior ensures that the mutex lock is not leaked. ~scoped_lock() { try{ if(m_locked && mp_mutex) mp_mutex->unlock(); } @@ -286,7 +286,7 @@ class scoped_lock //!Notes: The scoped_lock changes from a state of not owning the mutex, to //! owning the mutex, but only if blocking was not required. If the //! mutex_type does not support try_lock(), this function will fail at - //! compile time if instantiated, but otherwise have no effect.*/ + //! compile time if instantiated, but otherwise have no effect. bool try_lock() { if(!mp_mutex || m_locked) @@ -301,7 +301,7 @@ class scoped_lock //!Notes: The scoped_lock changes from a state of not owning the mutex, to //! owning the mutex, but only if it can obtain ownership by the specified //! time. If the mutex_type does not support timed_lock (), this function - //! will fail at compile time if instantiated, but otherwise have no effect.*/ + //! will fail at compile time if instantiated, but otherwise have no effect. bool timed_lock(const boost::posix_time::ptime& abs_time) { if(!mp_mutex || m_locked) @@ -314,7 +314,7 @@ class scoped_lock //! exception. Calls unlock() on the referenced mutex. //!Postconditions: owns() == false. //!Notes: The scoped_lock changes from a state of owning the mutex, to not - //! owning the mutex.*/ + //! owning the mutex. void unlock() { 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/boost/interprocess/sync/sharable_lock.hpp +++ b/boost/interprocess/sync/sharable_lock.hpp @@ -45,7 +45,7 @@ namespace interprocess { //!the Mutex does not supply, no harm is done. Mutex ownership can be shared among //!sharable_locks, and a single upgradable_lock. sharable_lock does not support //!copy semantics. But sharable_lock supports ownership transfer from an sharable_lock, -//!upgradable_lock and scoped_lock via transfer_lock syntax.*/ +//!upgradable_lock and scoped_lock via transfer_lock syntax. template class sharable_lock { @@ -136,7 +136,7 @@ class sharable_lock //!Notes: If upgr is locked, this constructor will lock this sharable_lock while //! unlocking upgr. Only a moved sharable_lock's will match this //! signature. An non-moved upgradable_lock can be moved with the expression: - //! "boost::move(lock);".*/ + //! "boost::move(lock);". template sharable_lock(BOOST_RV_REF(upgradable_lock) upgr , typename ipcdetail::enable_if< ipcdetail::is_same >::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/boost/interprocess/sync/shm/named_condition.hpp +++ b/boost/interprocess/sync/shm/named_condition.hpp @@ -83,7 +83,7 @@ class shm_named_condition ~shm_named_condition(); //!If there is a thread waiting on *this, change that - //!thread's state to ready. Otherwise there is no effect.*/ + //!thread's state to ready. Otherwise there is no effect. void notify_one(); //!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/boost/interprocess/sync/windows/named_condition.hpp +++ b/boost/interprocess/sync/windows/named_condition.hpp @@ -49,7 +49,7 @@ class windows_named_condition ~windows_named_condition(); //!If there is a thread waiting on *this, change that - //!thread's state to ready. Otherwise there is no effect.*/ + //!thread's state to ready. Otherwise there is no effect. void notify_one(); //!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/libs/container/test/heap_allocator_v1.hpp +++ b/libs/container/test/heap_allocator_v1.hpp @@ -41,7 +41,7 @@ namespace test { //!An STL compatible heap_allocator_v1 that uses a segment manager as //!memory source. The internal pointer type will of the same type (raw, smart) as //!"typename SegmentManager::void_pointer" type. This allows -//!placing the heap_allocator_v1 in shared memory, memory mapped-files, etc...*/ +//!placing the heap_allocator_v1 in shared memory, memory mapped-files, etc... template class heap_allocator_v1 { diff --git a/libs/interprocess/doc/interprocess.qbk b/libs/interprocess/doc/interprocess.qbk index 73f9b48..dbcc985 100644 --- a/libs/interprocess/doc/interprocess.qbk +++ b/libs/interprocess/doc/interprocess.qbk @@ -3088,7 +3088,7 @@ defines the following types: //!and offset_ptr as internal pointers) as memory allocation algorithm //!and the default index type as the index. //!This class allows the shared memory to be mapped in different base - //!in different processes*/ + //!in different processes typedef basic_managed_shared_memory class allocator_v1 { diff --git a/libs/interprocess/test/heap_allocator_v1.hpp b/libs/interprocess/test/heap_allocator_v1.hpp index d5b8bac..033ded0 100644 --- a/libs/interprocess/test/heap_allocator_v1.hpp +++ b/libs/interprocess/test/heap_allocator_v1.hpp @@ -41,7 +41,7 @@ namespace test { //!An STL compatible heap_allocator_v1 that uses a segment manager as //!memory source. The internal pointer type will of the same type (raw, smart) as //!"typename SegmentManager::void_pointer" type. This allows -//!placing the heap_allocator_v1 in shared memory, memory mapped-files, etc...*/ +//!placing the heap_allocator_v1 in shared memory, memory mapped-files, etc... template class heap_allocator_v1 { -- 1.7.7.6