mirror of
https://github.com/LadybirdBrowser/ladybird.git
synced 2024-08-16 17:00:35 +03:00
Documentation: Update names of RefPtr helper functions
This seems to have been missed when these functions were renamed.
This commit is contained in:
parent
4aaab80649
commit
5fe619de99
Notes:
sideshowbarker
2024-07-17 20:49:52 +09:00
Author: https://github.com/Rummskartoffel 🔰 Commit: https://github.com/SerenityOS/serenity/commit/5fe619de990 Pull-request: https://github.com/SerenityOS/serenity/pull/11923
@ -90,18 +90,18 @@ Note: A `NonnullRefPtr` can be assigned to a `RefPtr` but not vice versa. To tra
|
||||
|
||||
### Construction using helper functions
|
||||
|
||||
There is a `create<T>()` global helper function that constructs a new object and returns it wrapped in a `NonnullRefPtr`. All arguments passed to it are forwarded to `T`'s constructor. If memory cannot be allocated for the object, the program is terminated.
|
||||
There is a `make_ref_counted<T>()` global helper function that constructs a new object and returns it wrapped in a `NonnullRefPtr`. All arguments passed to it are forwarded to `T`'s constructor. If memory cannot be allocated for the object, the program is terminated.
|
||||
|
||||
```cpp
|
||||
NonnullRefPtr<Bar> our_object = create<Bar>();
|
||||
NonnullRefPtr<Bar> our_object = make_ref_counted<Bar>();
|
||||
NonnullRefPtr<Bar> another_owner = our_object;
|
||||
```
|
||||
|
||||
|
||||
The `try_create<T>()` function constructs an object wrapped in `RefPtr<T>` which may be null if the allocation does not succeed. This allows the calling code to handle allocation failure as it wishes. All arguments passed to it are forwarded to `T`'s constructor.
|
||||
The `try_make_ref_counted<T>()` function constructs an object wrapped in `RefPtr<T>` which may be null if the allocation does not succeed. This allows the calling code to handle allocation failure as it wishes. All arguments passed to it are forwarded to `T`'s constructor.
|
||||
|
||||
```cpp
|
||||
RefPtr<Bar> our_object = try_create<Bar>();
|
||||
RefPtr<Bar> our_object = try_make_ref_counted<Bar>();
|
||||
if (!our_object) {
|
||||
// handle allocation failure...
|
||||
}
|
||||
|
Loading…
Reference in New Issue
Block a user