Added comments to clientHandle

GueLaKais · GueLaKais · commit 5f417646ce15 · 2024-06-25T22:31:18.000+02:00
Client handle has no comments yet.
diff --git a/rclrs/src/client.rs b/rclrs/src/client.rs
@@ -30,6 +30,11 @@ pub struct ClientHandle {
 }
 
 impl ClientHandle {
+    /// Locks the `rcl_client_t` instance and returns a mutable reference to it.
+    ///
+    /// # Returns
+    ///
+    /// A `MutexGuard` holding a mutable reference to the `rcl_client_t` instance.
     pub(crate) fn lock(&self) -> MutexGuard<rcl_client_t> {
         self.rcl_client.lock().unwrap()
     }

Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,11 @@ pub struct ClientHandle {`
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`impl ClientHandle {`
	`33`	+ /// Locks the `rcl_client_t` instance and returns a mutable reference to it.
	`34`	`+ ///`
	`35`	`+ /// # Returns`
	`36`	`+ ///`
	`37`	+ /// A `MutexGuard` holding a mutable reference to the `rcl_client_t` instance.
`33`	`38`	`pub(crate) fn lock(&self) -> MutexGuard<rcl_client_t> {`
`34`	`39`	`self.rcl_client.lock().unwrap()`
`35`	`40`	`}`