From 1f872b3d88ceeb6b2c7b5b5645685b78d545c868 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pawe=C5=82?= Date: Wed, 5 Feb 2025 22:35:48 +0100 Subject: [PATCH] Tweak documentation a bit more --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 43b14fc..f7b3c23 100644 --- a/README.md +++ b/README.md @@ -100,6 +100,10 @@ int main(void) { } ``` +# Usage + +`oop_ptr` is a header only, single include utility. Just copy [this file](https://github.com/pwalig/oop_ptr/blob/main/oop_ptr.hpp) to your project's include directory. + # Features ## 1. Made to be consistent with smart pointers form C++ standard library: @@ -108,8 +112,6 @@ with methods like `release()` and `get()` and overloaded `->` and `*` operators ## 2. Customizable: with `#define`s you can include / exclude methods, operators and constructors from `oop_ptr` definition -## 3. Simple and understandable: -easy to analyze source code # Documentation @@ -167,6 +169,8 @@ In following definitions replace `b` with name of the base class and `c` with na | `OOP_PTR_PTR_COPY_OPERATOR` | `operator=(const T* ptr)` | no | | `OOP_PTR_PTR_MOVE_OPERATOR` | `operator=(T* ptr)` | no | +If you wish to customize `oop_ptr` it is encouraged that you put your `#define`s or remove existing ones directly in `oop_ptr.hpp` file. + > [!WARNING] > Do not define both: `OOP_PTR_PTR_COPY_OPERATOR` and `OOP_PTR_PTR_MOVE_OPERATOR` at once. > Do not define both: `OOP_PTR_PTR_COPY_CONSTRUCTOR` and `OOP_PTR_PTR_MOVE_CONSTRUCTOR` at once.