cpp-common/bt2: add `bt2::OptionalBorrowedObject`

[babeltrace.git] / src / cpp-common / bt2 / borrowed-object.hpp

diff --git a/src/cpp-common/bt2/borrowed-object.hpp b/src/cpp-common/bt2/borrowed-object.hpp
index f3b4fdcccec34daed47bafe45a60f8bbaf1668bf..fbfd5b10c35bbed058c2d6680d68eb752d03643a 100644 (file)
--- a/src/cpp-common/bt2/borrowed-object.hpp
+++ b/src/cpp-common/bt2/borrowed-object.hpp
@@ -25,6 +25,9 @@ namespace bt2 {
  *
  * The user of a borrowed object, including methods of a derived class,
  * can call libObjPtr() to access the libbabeltrace2 object pointer.
+ *
+ * You may only build a borrowed object with a pointer which isn't
+ * `nullptr`. See `bt2::OptionalBorrowedObject` for an optional version.
  */
 template <typename LibObjT>
 class BorrowedObject