From: igaztanaga_at_[hidden]
Date: 2008-06-22 13:43:16
Author: igaztanaga
Date: 2008-06-22 13:43:15 EDT (Sun, 22 Jun 2008)
New Revision: 46615
URL: http://svn.boost.org/trac/boost/changeset/46615
Log:
Fixes to avoid documentation warnings with Boostbook
Text files modified:
trunk/boost/interprocess/containers/flat_set.hpp | 11 +++++++++++
trunk/boost/interprocess/containers/slist.hpp | 5 +++--
trunk/boost/interprocess/containers/string.hpp | 3 ++-
trunk/boost/interprocess/detail/math_functions.hpp | 2 +-
trunk/boost/interprocess/file_mapping.hpp | 3 ++-
trunk/boost/interprocess/indexes/unordered_map_index.hpp | 4 ++++
trunk/boost/interprocess/ipc/message_queue.hpp | 3 ++-
trunk/boost/interprocess/mapped_region.hpp | 4 ++--
trunk/boost/interprocess/mem_algo/rbtree_best_fit.hpp | 4 ++++
trunk/boost/interprocess/shared_memory_object.hpp | 4 ++--
trunk/boost/interprocess/smart_ptr/enable_shared_from_this.hpp | 4 ++++
trunk/boost/interprocess/sync/file_lock.hpp | 2 ++
trunk/boost/interprocess/sync/interprocess_condition.hpp | 2 ++
trunk/boost/interprocess/sync/interprocess_upgradable_mutex.hpp | 5 ++++-
trunk/boost/interprocess/sync/named_condition.hpp | 7 +++++++
trunk/boost/interprocess/sync/named_recursive_mutex.hpp | 4 ++++
trunk/boost/interprocess/sync/named_upgradable_mutex.hpp | 5 ++++-
trunk/boost/interprocess/windows_shared_memory.hpp | 4 ++--
18 files changed, 62 insertions(+), 14 deletions(-)
Modified: trunk/boost/interprocess/containers/flat_set.hpp
==============================================================================
--- trunk/boost/interprocess/containers/flat_set.hpp (original)
+++ trunk/boost/interprocess/containers/flat_set.hpp 2008-06-22 13:43:15 EDT (Sun, 22 Jun 2008)
@@ -588,6 +588,17 @@
const flat_multiset<T,Pred,Alloc>& y);
/// @endcond
+//! flat_multiset is a Sorted Associative Container that stores objects of type Key.
+//! flat_multiset is a Simple Associative Container, meaning that its value type,
+//! as well as its key type, is Key.
+//! flat_Multiset can store multiple copies of the same key value.
+//!
+//! flat_multiset is similar to std::multiset but it's implemented like an ordered vector.
+//! This means that inserting a new element into a flat_multiset invalidates
+//! previous iterators and references
+//!
+//! Erasing an element of a flat_multiset invalidates iterators and references
+//! pointing to elements that come after (their keys are equal or bigger) the erased element.
template <class T, class Pred, class Alloc>
class flat_multiset
{
Modified: trunk/boost/interprocess/containers/slist.hpp
==============================================================================
--- trunk/boost/interprocess/containers/slist.hpp (original)
+++ trunk/boost/interprocess/containers/slist.hpp 2008-06-22 13:43:15 EDT (Sun, 22 Jun 2008)
@@ -1426,7 +1426,8 @@
// Specialization of insert_iterator so that insertions will be constant
// time rather than linear time.
-//iG
+///@cond
+
//Ummm, I don't like to define things in namespace std, but
//there is no other way
namespace std {
@@ -1464,7 +1465,7 @@
} //namespace std;
-
+///@endcond
#include <boost/interprocess/detail/config_end.hpp>
Modified: trunk/boost/interprocess/containers/string.hpp
==============================================================================
--- trunk/boost/interprocess/containers/string.hpp (original)
+++ trunk/boost/interprocess/containers/string.hpp 2008-06-22 13:43:15 EDT (Sun, 22 Jun 2008)
@@ -520,8 +520,9 @@
/// @endcond
public: // Constructor, destructor, assignment.
-
+ /// @cond
struct reserve_t {};
+ /// @endcond
basic_string(reserve_t, std::size_t n,
const allocator_type& a = allocator_type())
Modified: trunk/boost/interprocess/detail/math_functions.hpp
==============================================================================
--- trunk/boost/interprocess/detail/math_functions.hpp (original)
+++ trunk/boost/interprocess/detail/math_functions.hpp 2008-06-22 13:43:15 EDT (Sun, 22 Jun 2008)
@@ -89,7 +89,7 @@
{
const std::size_t Bits = sizeof(std::size_t)*CHAR_BIT;
const bool Size_t_Bits_Power_2= !(Bits & (Bits-1));
- BOOST_STATIC_ASSERT(Size_t_Bits_Power_2);
+ BOOST_STATIC_ASSERT(((Size_t_Bits_Power_2)== true));
std::size_t n = x;
std::size_t log2 = 0;
Modified: trunk/boost/interprocess/file_mapping.hpp
==============================================================================
--- trunk/boost/interprocess/file_mapping.hpp (original)
+++ trunk/boost/interprocess/file_mapping.hpp 2008-06-22 13:43:15 EDT (Sun, 22 Jun 2008)
@@ -160,6 +160,8 @@
m_mode = mode;
}
+///@cond
+
inline void file_mapping::priv_close()
{
if(m_handle != detail::invalid_file()){
@@ -168,7 +170,6 @@
}
}
-///@cond
//!Trait class to detect if a type is
//!movable
Modified: trunk/boost/interprocess/indexes/unordered_map_index.hpp
==============================================================================
--- trunk/boost/interprocess/indexes/unordered_map_index.hpp (original)
+++ trunk/boost/interprocess/indexes/unordered_map_index.hpp 2008-06-22 13:43:15 EDT (Sun, 22 Jun 2008)
@@ -27,6 +27,8 @@
namespace boost {
namespace interprocess {
+///@cond
+
//!Helper class to define typedefs from
//!IndexTraits
template <class MapConfig>
@@ -55,6 +57,8 @@
key_equal, allocator_type> index_t;
};
+///@endcond
+
//!Index type based in unordered_map. Just derives from unordered_map and
//!defines the interface needed by managed memory segments
template <class MapConfig>
Modified: trunk/boost/interprocess/ipc/message_queue.hpp
==============================================================================
--- trunk/boost/interprocess/ipc/message_queue.hpp (original)
+++ trunk/boost/interprocess/ipc/message_queue.hpp 2008-06-22 13:43:15 EDT (Sun, 22 Jun 2008)
@@ -368,7 +368,6 @@
};
} //namespace detail {
-/// @endcond
inline message_queue::~message_queue()
{}
@@ -611,6 +610,8 @@
inline bool message_queue::remove(const char *name)
{ return shared_memory_object::remove(name); }
+/// @endcond
+
}} //namespace boost{ namespace interprocess{
#include <boost/interprocess/detail/config_end.hpp>
Modified: trunk/boost/interprocess/mapped_region.hpp
==============================================================================
--- trunk/boost/interprocess/mapped_region.hpp (original)
+++ trunk/boost/interprocess/mapped_region.hpp 2008-06-22 13:43:15 EDT (Sun, 22 Jun 2008)
@@ -152,6 +152,8 @@
/// @endcond
};
+///@cond
+
inline void swap(mapped_region &x, mapped_region &y)
{ x.swap(y); }
@@ -556,8 +558,6 @@
#endif
}
-/// @cond
-
//!No-op functor
struct null_mapped_region_function
{
Modified: trunk/boost/interprocess/mem_algo/rbtree_best_fit.hpp
==============================================================================
--- trunk/boost/interprocess/mem_algo/rbtree_best_fit.hpp (original)
+++ trunk/boost/interprocess/mem_algo/rbtree_best_fit.hpp 2008-06-22 13:43:15 EDT (Sun, 22 Jun 2008)
@@ -352,6 +352,8 @@
static const std::size_t PayloadPerAllocation = AllocatedCtrlBytes - UsableByPreviousChunk;
};
+/// @cond
+
template<class MutexFamily, class VoidPointer, std::size_t MemAlignment>
inline std::size_t rbtree_best_fit<MutexFamily, VoidPointer, MemAlignment>
::priv_first_block_offset(const void *this_ptr, std::size_t extra_hdr_bytes)
@@ -1332,6 +1334,8 @@
priv_mark_as_free_block(block_to_insert);
}
+/// @endcond
+
} //namespace interprocess {
} //namespace boost {
Modified: trunk/boost/interprocess/shared_memory_object.hpp
==============================================================================
--- trunk/boost/interprocess/shared_memory_object.hpp (original)
+++ trunk/boost/interprocess/shared_memory_object.hpp 2008-06-22 13:43:15 EDT (Sun, 22 Jun 2008)
@@ -152,6 +152,8 @@
/// @endcond
};
+/// @cond
+
inline shared_memory_object::shared_memory_object()
: m_handle(file_handle_t(detail::invalid_file()))
{}
@@ -343,8 +345,6 @@
#endif
-///@cond
-
//!Trait class to detect if a type is
//!movable
template<>
Modified: trunk/boost/interprocess/smart_ptr/enable_shared_from_this.hpp
==============================================================================
--- trunk/boost/interprocess/smart_ptr/enable_shared_from_this.hpp (original)
+++ trunk/boost/interprocess/smart_ptr/enable_shared_from_this.hpp 2008-06-22 13:43:15 EDT (Sun, 22 Jun 2008)
@@ -27,6 +27,10 @@
namespace boost{
namespace interprocess{
+//!This class is used as a base class that allows a shared_ptr to the current
+//!object to be obtained from within a member function.
+//!enable_shared_from_this defines two member functions called shared_from_this
+//!that return a shared_ptr<T> and shared_ptr<T const>, depending on constness, to this.
template<class T, class A, class D>
class enable_shared_from_this
{
Modified: trunk/boost/interprocess/sync/file_lock.hpp
==============================================================================
--- trunk/boost/interprocess/sync/file_lock.hpp (original)
+++ trunk/boost/interprocess/sync/file_lock.hpp 2008-06-22 13:43:15 EDT (Sun, 22 Jun 2008)
@@ -32,6 +32,8 @@
//!A file lock, is a mutual exclusion utility similar to a mutex using a
//!file. A file lock has sharable and exclusive locking capabilities and
//!can be used with scoped_lock and sharable_lock classes.
+//!A file lock can't guarantee synchronization between threads of the same
+//!process so just use file locks to synchronize threads from different processes.
class file_lock
{
/// @cond
Modified: trunk/boost/interprocess/sync/interprocess_condition.hpp
==============================================================================
--- trunk/boost/interprocess/sync/interprocess_condition.hpp (original)
+++ trunk/boost/interprocess/sync/interprocess_condition.hpp 2008-06-22 13:43:15 EDT (Sun, 22 Jun 2008)
@@ -50,6 +50,8 @@
class named_condition;
+//!This class is a condition variable that can be placed in shared memory or
+//!memory mapped files.
class interprocess_condition
{
/// @cond
Modified: trunk/boost/interprocess/sync/interprocess_upgradable_mutex.hpp
==============================================================================
--- trunk/boost/interprocess/sync/interprocess_upgradable_mutex.hpp (original)
+++ trunk/boost/interprocess/sync/interprocess_upgradable_mutex.hpp 2008-06-22 13:43:15 EDT (Sun, 22 Jun 2008)
@@ -266,6 +266,8 @@
/// @endcond
};
+/// @cond
+
template <int Dummy>
const unsigned interprocess_upgradable_mutex::base_constants_t<Dummy>::max_readers;
@@ -633,8 +635,9 @@
return true;
}
-} //namespace interprocess {
+/// @endcond
+} //namespace interprocess {
} //namespace boost {
Modified: trunk/boost/interprocess/sync/named_condition.hpp
==============================================================================
--- trunk/boost/interprocess/sync/named_condition.hpp (original)
+++ trunk/boost/interprocess/sync/named_condition.hpp 2008-06-22 13:43:15 EDT (Sun, 22 Jun 2008)
@@ -40,6 +40,9 @@
namespace detail{ class interprocess_tester; }
/// @endcond
+//! A global condition variable that can be created by name.
+//! This condition variable is designed to work with named_mutex and
+//! can't be placed in shared memory or memory mapped files.
class named_condition
{
/// @cond
@@ -183,6 +186,8 @@
/// @endcond
};
+/// @cond
+
inline named_condition::~named_condition()
{}
@@ -329,6 +334,8 @@
inline bool named_condition::remove(const char *name)
{ return shared_memory_object::remove(name); }
+/// @endcond
+
} //namespace interprocess
} //namespace boost
Modified: trunk/boost/interprocess/sync/named_recursive_mutex.hpp
==============================================================================
--- trunk/boost/interprocess/sync/named_recursive_mutex.hpp (original)
+++ trunk/boost/interprocess/sync/named_recursive_mutex.hpp 2008-06-22 13:43:15 EDT (Sun, 22 Jun 2008)
@@ -108,6 +108,8 @@
/// @endcond
};
+/// @cond
+
inline named_recursive_mutex::~named_recursive_mutex()
{}
@@ -159,6 +161,8 @@
inline bool named_recursive_mutex::remove(const char *name)
{ return shared_memory_object::remove(name); }
+/// @endcond
+
} //namespace interprocess {
} //namespace boost {
Modified: trunk/boost/interprocess/sync/named_upgradable_mutex.hpp
==============================================================================
--- trunk/boost/interprocess/sync/named_upgradable_mutex.hpp (original)
+++ trunk/boost/interprocess/sync/named_upgradable_mutex.hpp 2008-06-22 13:43:15 EDT (Sun, 22 Jun 2008)
@@ -233,6 +233,8 @@
/// @endcond
};
+/// @cond
+
inline named_upgradable_mutex::~named_upgradable_mutex()
{}
@@ -339,8 +341,9 @@
inline bool named_upgradable_mutex::remove(const char *name)
{ return shared_memory_object::remove(name); }
-} //namespace interprocess {
+/// @endcond
+} //namespace interprocess {
} //namespace boost {
#include <boost/interprocess/detail/config_end.hpp>
Modified: trunk/boost/interprocess/windows_shared_memory.hpp
==============================================================================
--- trunk/boost/interprocess/windows_shared_memory.hpp (original)
+++ trunk/boost/interprocess/windows_shared_memory.hpp 2008-06-22 13:43:15 EDT (Sun, 22 Jun 2008)
@@ -143,6 +143,8 @@
/// @endcond
};
+/// @cond
+
inline windows_shared_memory::windows_shared_memory()
: m_handle(0)
{}
@@ -235,8 +237,6 @@
}
}
-///@cond
-
//!Trait class to detect if a type is
//!movable
template<>