diff options
author | Ben Wiederhake <BenWiederhake.GitHub@gmx.de> | 2021-09-11 11:11:48 +0200 |
---|---|---|
committer | Andreas Kling <kling@serenityos.org> | 2021-09-11 13:17:44 +0200 |
commit | 4acdea7cfee15eb6dce78afeb6762ef9b726f0f0 (patch) | |
tree | 99b2b7a13921f7620efa7245fbd4d19e3d164c05 /Documentation/SmartPointers.md | |
parent | 79bcb908874f028c4babff90d2c73d6af779da86 (diff) | |
download | serenity-4acdea7cfee15eb6dce78afeb6762ef9b726f0f0.zip |
Documentation: Fix slightly-broken headers
GithubFlavoredMarkdown sees the angled brackets (<>) and censors them.
Perhaps because it does not allow HTML tags in headings.
Diffstat (limited to 'Documentation/SmartPointers.md')
-rw-r--r-- | Documentation/SmartPointers.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/Documentation/SmartPointers.md b/Documentation/SmartPointers.md index 6b332c72ed..4401af4b35 100644 --- a/Documentation/SmartPointers.md +++ b/Documentation/SmartPointers.md @@ -9,7 +9,7 @@ The reason for using these pointers is to make it explicit through code who owns ---- -## OwnPtr<T> and NonnullOwnPtr<T> +## OwnPtr\<T\> and NonnullOwnPtr\<T\> `OwnPtr` is used for single-owner objects. An object held in an `OwnPtr` is owned by that `OwnPtr`, and not by anybody else. @@ -68,7 +68,7 @@ In this case, the *non-throwing* `new` should be used to construct the raw point **Note:** Always prefer the helper functions to manual construction. ---- -## RefPtr<T> and NonnullRefPtr<T> +## RefPtr\<T\> and NonnullRefPtr\<T\> `RefPtr` is used for multiple-owner objects. An object held by a `RefPtr` is owned together by every pointer pointing to that object. @@ -132,7 +132,7 @@ In this case, the *non-throwing* `new` should be used to construct the raw point **Note:** Always prefer the helper functions to manual construction. ---- -## WeakPtr<T> +## WeakPtr\<T\> `WeakPtr` is used for objects that somebody else owns. When the pointee of a `WeakPtr` is deleted, the `WeakPtr` will magically become null. |