wip

Author: jll63

include/boost/openmethod/core.hpp

@@ -614,7 +614,7 @@ class virtual_ptr {
           obj(nullptr) {
     }
 
-    //! Constructs a `virtual_ptr` from a reference to an object
+    //! Construct a `virtual_ptr` from a reference to an object
     //!
     //! The pointer to the v-table is obtained by calling
     //! @ref boost_openmethod_vptr if a suitable overload exists, or the
@@ -642,7 +642,7 @@ class virtual_ptr {
     //! @par Requirements
     //! @li `Other` must be a polymorphic class, according to `Registry`'s
     //! `rtti` policy.
-    //! @li `Other*` must be constructible from `Class*`.
+    //! @li `Other\*` must be constructible from `Class\*`.
     //!
     //! @par Errors
     //!
@@ -662,7 +662,7 @@ class virtual_ptr {
           obj(&other) {
     }
 
-    //! Constructs a `virtual_ptr` from a pointer to an object
+    //! Construct a `virtual_ptr` from a pointer to an object
     //!
     //! The pointer to the v-table is obtained by calling
     //! @ref boost_openmethod_vptr if a suitable overload exists, or the
@@ -692,7 +692,7 @@ class virtual_ptr {
     //! @li `Other` must be a polymorphic class, according to `Registry`'s
     //! `rtti` policy.
     //!
-    //! @li `Other*` must be constructible from `Class*`.
+    //! @li `Other\*` must be constructible from `Class\*`.
     //!
     //! @par Errors
     //!
@@ -713,11 +713,9 @@ class virtual_ptr {
           obj(other) {
     }
 
-    //! Constructs a `virtual_ptr` from a `virtual_ptr`
-    //!
-    //! The pointer to the v-table is copied from `other`.
+    //! Construct a `virtual_ptr` from another `virtual_ptr`
     //!
-    //! `Other` is _not_ required to be a pointer to a polymorphic class.
+    //! Copy the object and v-table pointers from `other` to `this`.
     //!
     //! @param other A virtual_ptr to a type-compatible object
     //!
@@ -739,7 +737,7 @@ class virtual_ptr {
     //!
     //! @par Requirements
     //!
-    //! @li `Other*` must be constructible from `Class*`.
+    //! @li `Other\*` must be constructible from `Class\*`.
     template<
         class Other,
         typename = std::enable_if_t<std::is_constructible_v<
@@ -748,9 +746,9 @@ class virtual_ptr {
         : vp(other.vp), obj(other.get()) {
     }
 
-    //! Constructs a `virtual_ptr` from a `virtual_ptr`
+    //! Construct a `virtual_ptr` from another `virtual_ptr`
     //!
-    //! The pointer to the v-table is copied from `other`.
+    //! Copy the object and v-table pointers from `other` to `this`.
     //!
     //! `Other` is _not_ required to be a pointer to a polymorphic class.
     //!
@@ -774,7 +772,7 @@ class virtual_ptr {
     //!
     //! @par Requirements
     //!
-    //! @li `Other*` must be constructible from `Class*`.
+    //! @li `Other\*` must be constructible from `Class\*`.
     template<
         class Other,
         typename = std::enable_if_t<std::is_constructible_v<
@@ -791,7 +789,7 @@ class virtual_ptr {
         // that is incorrect.
     }
 
-    //! Set a `virtual_ptr` to point to an object
+    //! Assign a `virtual_ptr` from a reference to an object
     //!
     //! The pointer to the v-table is obtained by calling
     //! @ref boost_openmethod_vptr if a suitable overload exists, or the
@@ -822,7 +820,7 @@ class virtual_ptr {
     //! @li `Other` must be a polymorphic class, according to `Registry`'s
     //! `rtti` policy.
     //!
-    //! @li `Other*` must be constructible from `Class*`.
+    //! @li `Other\*` must be constructible from `Class\*`.
     //!
     //! @par Errors
     //!
@@ -843,7 +841,7 @@ class virtual_ptr {
         return *this;
     }
 
-    //! Set a `virtual_ptr` to point to an object
+    //! Assign a `virtual_ptr` from a pointer to an object
     //!
     //! The pointer to the v-table is obtained by calling
     //! @ref boost_openmethod_vptr if a suitable overload exists, or the
@@ -872,7 +870,7 @@ class virtual_ptr {
     //! @par Requirements
     //! @li `Other` must be a polymorphic class, according to `Registry`'s
     //! `rtti` policy.
-    //! @li `Other*` must be constructible from `Class*`.
+    //! @li `Other\*` must be constructible from `Class\*`.
     //!
     //! @par Errors
     //!
@@ -893,7 +891,7 @@ class virtual_ptr {
         return *this;
     }
 
-    //! Assign a `virtual_ptr` from a `virtual_ptr`
+    //! Assign a `virtual_ptr` from another `virtual_ptr`
     //!
     //! The pointer to the v-table is copied from `other`.
     //!
@@ -919,7 +917,7 @@ class virtual_ptr {
     //! @param other A virtual_ptr to a type-compatible polymorphic object
     //!
     //! @par Requirements
-    //! @li `Other*` must be constructible from `Class*`.
+    //! @li `Other\*` must be constructible from `Class\*`.
     template<
         class Other,
         typename = std::enable_if_t<std::is_assignable_v<