Add documentation for shared pointer class #671
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@jen3andruska Could you please copy edit this file when you get a chance? |
|
@AnotherButler No problem! |
|
@AnotherButler Finished copy-editing and made revisions. |
Fix spacing in SharedPtr.md
|
@jen3andruska Thanks for the CE. It looks great 👍 |
pan-
requested changes
Aug 27, 2018
|
|
||
| When `ptr` is passed around by a value, the copy constructor and destructor manage the reference count of the raw pointer. If the counter reaches zero, `delete` is called on the raw pointer. | ||
|
|
||
| To avoid loops, use "weak" references by calling the original pointer directly with `ptr.get()`. |
There was a problem hiding this comment.
I would remove that sentence as it is misleading and can lead to access of a dangling pointer as it is not possible to know if a pointer acquired previously with ptr.get() is valid or not.
|
@AnotherButler No Problem 👍 |
|
Thanks @jen3andruska @pan- @AnotherButler |
cmonr
reviewed
Aug 28, 2018
| @@ -0,0 +1,34 @@ | |||
| ## Shared Pointer | |||
|
|
|||
| A shared pointer is a "smart" pointer that retains ownership of an object by using reference counting accross all smart pointers referencing that object. | |||
There was a problem hiding this comment.
Could it be clarified what that is suppose to mean in this sentence?
|
|
||
| Usage: `SharedPtr<Class> ptr(new Class())` | ||
|
|
||
| When `ptr` is passed around by a value, the copy constructor and destructor manage the reference count of the raw pointer. If the counter reaches zero, `delete` is called on the raw pointer. |
|
@pan- Mind re-reviewing? Looks like GitHub didn't catch the update (for some reason) |
|
ping @pan- |
pan-
approved these changes
Aug 29, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is the associated documentation PR for ARMmbed/mbed-os#7815.