More warnings about smart* parts of the library

boostorg · Jan 28, 2025 · 841e188 · 841e188
1 parent 753af61
commit 841e188
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 4 deletions.
diff --git a/doc/mangled.qbk b/doc/mangled.qbk
@@ -12,6 +12,9 @@
 
 This section describes the experimental feature of allowing the import of mangled symbols from an dll. While this feature is unique to this library and looks quite promising, it is not throroughly tested and thus not considered stable.
 
+\warning Experimental feature that relies on an incomplete implementation of platform specific C++
+         mangling. In case of an issue provide a PR with a fix and tests to https://github.com/boostorg/dll
+
 As a short example we can import the following functions quite easily:
 
 ```

diff --git a/include/boost/dll/import_class.hpp b/include/boost/dll/import_class.hpp
@@ -9,7 +9,9 @@
 #define BOOST_DLL_IMPORT_CLASS_HPP_
 
 /// \file boost/dll/import_class.hpp
-/// \warning Extremely experimental! May change in next version of Boost! boost/dll/import_class.hpp is not included in boost/dll.hpp
+/// \warning Experimental feature that relies on an incomplete implementation of platform specific C++
+///          mangling. In case of an issue provide a PR with a fix and tests to https://github.com/boostorg/dll .
+///          boost/dll/import_class.hpp is not included in boost/dll.hpp
 /// \brief Contains the boost::dll::experimental::import_class function for importing classes.
 
 #include <boost/dll/smart_library.hpp>

diff --git a/include/boost/dll/import_mangled.hpp b/include/boost/dll/import_mangled.hpp
@@ -9,7 +9,9 @@
 #define BOOST_DLL_IMPORT_MANGLED_HPP_
 
 /// \file boost/dll/import_mangled.hpp
-/// \warning Extremely experimental! May change in next version of Boost! boost/dll/import_mangled.hpp is not included in boost/dll.hpp
+/// \warning Experimental feature that relies on an incomplete implementation of platform specific C++
+///          mangling. In case of an issue provide a PR with a fix and tests to https://github.com/boostorg/dll .
+///          boost/dll/import_mangled.hpp is not included in boost/dll.hpp
 /// \brief Contains the boost::dll::experimental::import_mangled function for importing mangled symbols.
 
 #include <boost/dll/config.hpp>

diff --git a/include/boost/dll/smart_library.hpp b/include/boost/dll/smart_library.hpp
@@ -9,7 +9,9 @@
 #define BOOST_DLL_SMART_LIBRARY_HPP_
 
 /// \file boost/dll/smart_library.hpp
-/// \warning Extremely experimental! May change in next version of Boost! boost/dll/smart_library.hpp is not included in boost/dll.hpp
+/// \warning Experimental feature that relies on an incomplete implementation of platform specific C++
+///          mangling. In case of an issue provide a PR with a fix and tests to https://github.com/boostorg/dll .
+///          boost/dll/smart_library.hpp is not included in boost/dll.hpp
 /// \brief Contains the boost::dll::experimental::smart_library class for loading mangled symbols.
 
 #include <boost/dll/config.hpp>
@@ -44,7 +46,8 @@ using boost::dll::detail::destructor;
 * This class allows type safe loading of overloaded functions, member-functions, constructors and variables.
 * It also allows to overwrite classes so they can be loaded, while being declared with different names.
 *
-* \warning Is still very experimental.
+* \warning Experimental feature that relies on an incomplete implementation of platform specific C++
+*          mangling. In case of an issue provide a PR with a fix and tests to https://github.com/boostorg/dll
 *
 * Currently known limitations:
 *