From 770f3ba958842854f0ae7e09ba6fac7ec43b97ca Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=B6=20Fahlke?= <jorrit@jorrit.de>
Date: Thu, 13 Nov 2014 12:06:50 +0100
Subject: [PATCH] [doc][stackobject_to_shared_ptr()] Improve documentation.
Add "@relatesalso null_deleter", this includes the documentation for the
function with null_deleter but also leaves a standalone version. Document
what is so special about the shared_ptr the function returns. Mention the
#include needed to get the function.
---
dune/common/shared_ptr.hh | 26 ++++++++++++++++++++++++--
1 file changed, 24 insertions(+), 2 deletions(-)
diff --git a/dune/common/shared_ptr.hh b/dune/common/shared_ptr.hh
index 39c6dde47..5363cda72 100644
--- a/dune/common/shared_ptr.hh
+++ b/dune/common/shared_ptr.hh
@@ -55,11 +55,22 @@ namespace Dune
};
/**
- @brief Convert a stack-allocated object to a shared_ptr:
+ @brief Create a shared_ptr for a stack-allocated object
+ @relatesalso null_deleter
+ @code
+ #include <dune/common/shared_ptr.hh>
+ @endcode
+
+ Usage:
@code
int i = 10;
shared_ptr<int> pi = stackobject_to_shared_ptr(i);
@endcode
+ The @c shared_ptr points to the object on the stack, but its deleter is
+ set to an instance of @c null_deleter so that nothing happens when the @c
+ shared_ptr is destroyed.
+
+ @sa shared_ptr, null_deleter
*/
template<typename T>
inline shared_ptr<T> stackobject_to_shared_ptr(T & t)
@@ -68,7 +79,13 @@ namespace Dune
}
/**
- @brief Convert a stack object to a shared_ptr of a base class
+ @brief Create a shared_ptr to a base class for a stack-allocated object
+ @relatesalso null_deleter
+ @code
+ #include <dune/common/shared_ptr.hh>
+ @endcode
+
+ Usage:
@code
class A {};
class B : public A {};
@@ -78,6 +95,11 @@ namespace Dune
B b;
shared_ptr<A> pa = stackobject_to_shared_ptr<A>(b);
@endcode
+ The @c shared_ptr points to the object on the stack, but its deleter is
+ set to an instance of @c null_deleter so that nothing happens when the @c
+ shared_ptr is destroyed.
+
+ @sa shared_ptr, null_deleter
*/
template<typename T, typename T2>
inline shared_ptr<T2> stackobject_to_shared_ptr(T & t)
--
GitLab