wip

Author: jll63

include/boost/openmethod/core.hpp

@@ -527,12 +527,18 @@ inline auto final_virtual_ptr(Arg&& obj) {
 
 //! Wide pointer combining pointers to an object and its v-table
 //!
-//! `virtual_ptr` is a wide pointer that combines a pointer to an object and a
-//! pointer to its v-table. It can be constructed from a reference, a pointer,
-//! or another (possibly smart) `virtual_ptr`.
+//! A `virtual_ptr` is a wide pointer that combines pointers to an object and
+//! its v-table. Calls to methods via `virtual_ptr` are as fast as ordinary
+//! virtual function calls (typically two instructions).
 //!
-//! Calls to methods via `virtual_ptr` are as fast as ordinary virtual function
-//! calls (typically two instructions).
+//! A `virtual_ptr` can be implicitly constructed from a reference, a pointer,
+//! or another `virtual_ptr`, provided that they are type-compatible.
+//!
+//! `virtual_ptr` has specializations that use a `std::shared_ptr` or a
+//! `std::unique_ptr` as the pointer to the object. The mechanism can be
+//! extended to other smart pointers by specializing @ref virtual_traits. A
+//! "plain" `virtual_ptr` can be constructed from a smart `virtual_ptr`, but not
+//! the other way around.
 //!
 //! TODO: link out from mrdocs to macro documentation
 //! The default value for `Registry` can be customized by defining the <a href="openmethod/BOOST_OPENMETHOD_DEFAULT_REGISTRY.html">BOOST_OPENMETHOD_DEFAULT_REGISTRY</a>
@@ -749,7 +755,12 @@ class virtual_ptr {
     //!
     //! Copy the object and v-table pointers from `other` to `this`.
     //!
-    //! `Other` is _not_ required to be a pointer to a polymorphic class.
+    //! A plain `virtual_ptr` can be constructed from a smart virtual_ptr, as
+    //! long as the smart pointer's element type is convertible to the plain
+    //! pointer's element type.
+    //!
+    //! `Other::element_type` is _not_ required to be a pointer to a polymorphic
+    //! class.
     //!
     //! @par Example
     //! @code