Skip to content

Commit 0477e68

Browse files
committed
Add documentation for new constructors and operators
1 parent 3c8b007 commit 0477e68

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

src/ArduinoCellular.h

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,12 +108,28 @@ class ArduinoCellular {
108108
*/
109109
~ArduinoCellular();
110110

111-
// Delete copy operations (since unique_ptr can't be copied)
111+
/**
112+
* @brief Deleted copy constructor and assignment operator to prevent copying.
113+
* unique_ptr is used to manage the lifetime of the clients but they cannot be copied.
114+
*/
112115
ArduinoCellular(const ArduinoCellular&) = delete;
116+
117+
/**
118+
* @brief Deleted assignment operator to prevent copying.
119+
* unique_ptr is used to manage the lifetime of the clients but they cannot be copied.
120+
*/
113121
ArduinoCellular& operator=(const ArduinoCellular&) = delete;
114122

115-
// Enable move operations
123+
/**
124+
* @brief Move constructor for the ArduinoCellular class.
125+
* Allows moving the instance to another instance.
126+
*/
116127
ArduinoCellular(ArduinoCellular&&) = default;
128+
129+
/**
130+
* @brief Move assignment operator for the ArduinoCellular class.
131+
* Allows moving the instance to another instance.
132+
*/
117133
ArduinoCellular& operator=(ArduinoCellular&&) = default;
118134

119135
/**

0 commit comments

Comments
 (0)