Merge "libutils: better docs for sp<>::make" am: 767f264fa4 am: fb91070a83

Original change: https://android-review.googlesource.com/c/platform/system/core/+/1663182

Change-Id: Ic744b3b251fccd14b616dc1ce691dd57f5ab3255
This commit is contained in:
Steven Moreland 2021-04-02 22:31:20 +00:00 committed by Automerger Merge Worker
commit 2eb2b5edbf

View file

@ -32,9 +32,21 @@ class sp {
public: public:
inline sp() : m_ptr(nullptr) { } inline sp() : m_ptr(nullptr) { }
// TODO: switch everyone to using this over new, and make RefBase operator // The old way of using sp<> was like this. This is bad because it relies
// new private to that class so that we can avoid RefBase being used with // on implicit conversion to sp<>, which we would like to remove (if an
// other memory management mechanisms. // object is being managed some other way, this is double-ownership). We
// want to move away from this:
//
// sp<Foo> foo = new Foo(...); // DO NOT DO THIS
//
// Instead, prefer to do this:
//
// sp<Foo> foo = sp<Foo>::make(...); // DO THIS
//
// Sometimes, in order to use this, when a constructor is marked as private,
// you may need to add this to your class:
//
// friend class sp<Foo>;
template <typename... Args> template <typename... Args>
static inline sp<T> make(Args&&... args); static inline sp<T> make(Args&&... args);