Skip to content

Commit 8a16367

Browse files
committed
Get rid of doc links to private structs
Signed-off-by: Michael X. Grey <[email protected]>
1 parent 0efa831 commit 8a16367

File tree

8 files changed

+25
-25
lines changed

8 files changed

+25
-25
lines changed

rclrs/src/client.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ use crate::{rcl_bindings::*, NodeHandle, RclrsError, ENTITY_LIFECYCLE_MUTEX};
1515
// they are running in. Therefore, this type can be safely sent to another thread.
1616
unsafe impl Send for rcl_client_t {}
1717

18-
/// Manage the lifecycle of an [`rcl_client_t`], including managing its dependencies
19-
/// on [`rcl_node_t`] and [`rcl_context_t`] by ensuring that these dependencies are
20-
/// [dropped after][1] the [`rcl_client_t`].
18+
/// Manage the lifecycle of an `rcl_client_t`, including managing its dependencies
19+
/// on `rcl_node_t` and `rcl_context_t` by ensuring that these dependencies are
20+
/// [dropped after][1] the `rcl_client_t`.
2121
///
2222
/// [1] https://doc.rust-lang.org/reference/destructors.html
2323
pub struct ClientHandle {

rclrs/src/context.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ use crate::{RclrsError, ToResult};
1010
/// This is locked whenever initializing or dropping any middleware entity
1111
/// because we have found issues in RCL and some RMW implementations that
1212
/// make it unsafe to simultaneously initialize and/or drop middleware
13-
/// entities such as [`rcl_context_t`] and [`rcl_node_t`] as well middleware
14-
/// primitives such as [`rcl_publisher_t`], [`rcl_subscription_t`], etc.
13+
/// entities such as `rcl_context_t` and `rcl_node_t` as well middleware
14+
/// primitives such as `rcl_publisher_t`, `rcl_subscription_t`, etc.
1515
/// It seems these C and C++ based libraries will regularly use
1616
/// unprotected global variables in their object initialization and cleanup.
1717
///
@@ -59,10 +59,10 @@ pub struct Context {
5959
pub(crate) handle: Arc<ContextHandle>,
6060
}
6161

62-
/// This struct manages the lifetime and access to the [`rcl_context_t`]. It will also
62+
/// This struct manages the lifetime and access to the `rcl_context_t`. It will also
6363
/// account for the lifetimes of any dependencies, if we need to add
6464
/// dependencies in the future (currently there are none). It is not strictly
65-
/// necessary to decompose [`Context`] and [`ContextHandle`] like this, but we are
65+
/// necessary to decompose `Context` and `ContextHandle` like this, but we are
6666
/// doing it to be consistent with the lifecycle management of other rcl
6767
/// bindings in this library.
6868
pub(crate) struct ContextHandle {

rclrs/src/node.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,9 @@ pub struct Node {
6868
pub(crate) handle: Arc<NodeHandle>,
6969
}
7070

71-
/// This struct manages the lifetime of an [`rcl_node_t`], and accounts for its
72-
/// dependency on the lifetime of its [`rcl_context_t`] by ensuring that this
73-
/// dependency is [dropped after][1] the [`rcl_node_t`].
71+
/// This struct manages the lifetime of an `rcl_node_t`, and accounts for its
72+
/// dependency on the lifetime of its `rcl_context_t` by ensuring that this
73+
/// dependency is [dropped after][1] the `rcl_node_t`.
7474
///
7575
/// [1] https://doc.rust-lang.org/reference/destructors.html
7676
pub(crate) struct NodeHandle {

rclrs/src/publisher.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ pub use loaned_message::*;
1818
// they are running in. Therefore, this type can be safely sent to another thread.
1919
unsafe impl Send for rcl_publisher_t {}
2020

21-
/// Manage the lifecycle of an [`rcl_publisher_t`], including managing its dependencies
22-
/// on [`rcl_node_t`] and [`rcl_context_t`] by ensuring that these dependencies are
23-
/// [dropped after][1] the [`rcl_publisher_t`].
21+
/// Manage the lifecycle of an `rcl_publisher_t`, including managing its dependencies
22+
/// on `rcl_node_t` and `rcl_context_t` by ensuring that these dependencies are
23+
/// [dropped after][1] the `rcl_publisher_t`.
2424
///
2525
/// [1] https://doc.rust-lang.org/reference/destructors.html
2626
struct PublisherHandle {

rclrs/src/service.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ use crate::{NodeHandle, ENTITY_LIFECYCLE_MUTEX};
1313
// they are running in. Therefore, this type can be safely sent to another thread.
1414
unsafe impl Send for rcl_service_t {}
1515

16-
/// Manage the lifecycle of an [`rcl_service_t`], including managing its dependencies
17-
/// on [`rcl_node_t`] and [`rcl_context_t`] by ensuring that these dependencies are
18-
/// [dropped after][1] the [`rcl_service_t`].
16+
/// Manage the lifecycle of an `rcl_service_t`, including managing its dependencies
17+
/// on `rcl_node_t` and `rcl_context_t` by ensuring that these dependencies are
18+
/// [dropped after][1] the `rcl_service_t`.
1919
///
2020
/// [1] https://doc.rust-lang.org/reference/destructors.html
2121
pub struct ServiceHandle {

rclrs/src/subscription.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ pub use readonly_loaned_message::*;
2121
// they are running in. Therefore, this type can be safely sent to another thread.
2222
unsafe impl Send for rcl_subscription_t {}
2323

24-
/// Manage the lifecycle of an [`rcl_subscription_t`], including managing its dependencies
25-
/// on [`rcl_node_t`] and [`rcl_context_t`] by ensuring that these dependencies are
26-
/// [dropped after][1] the [`rcl_subscription_t`].
24+
/// Manage the lifecycle of an `rcl_subscription_t`, including managing its dependencies
25+
/// on `rcl_node_t` and `rcl_context_t` by ensuring that these dependencies are
26+
/// [dropped after][1] the `rcl_subscription_t`.
2727
///
2828
/// [1] https://doc.rust-lang.org/reference/destructors.html
2929
pub struct SubscriptionHandle {

rclrs/src/wait.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ mod guard_condition;
2828
use exclusivity_guard::*;
2929
pub use guard_condition::*;
3030

31-
/// Manage the lifecycle of an [`rcl_wait_set_t`], including managing its dependency
32-
/// on [`rcl_context_t`] by ensuring that this dependency is [dropped after][1] the
33-
/// [`rcl_wait_set_t`].
31+
/// Manage the lifecycle of an `rcl_wait_set_t`, including managing its dependency
32+
/// on `rcl_context_t` by ensuring that this dependency is [dropped after][1] the
33+
/// `rcl_wait_set_t`.
3434
///
3535
/// [1] https://doc.rust-lang.org/reference/destructors.html
3636
struct WaitSetHandle {

rclrs/src/wait/guard_condition.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,9 @@ pub struct GuardCondition {
5252
pub(crate) in_use_by_wait_set: Arc<AtomicBool>,
5353
}
5454

55-
/// Manage the lifecycle of an [`rcl_guard_condition_t`], including managing its dependency
56-
/// on [`rcl_context_t`] by ensuring that this dependency is [dropped after][1] the
57-
/// [`rcl_guard_condition_t`].
55+
/// Manage the lifecycle of an `rcl_guard_condition_t`, including managing its dependency
56+
/// on `rcl_context_t` by ensuring that this dependency is [dropped after][1] the
57+
/// `rcl_guard_condition_t`.
5858
///
5959
/// [1] https://doc.rust-lang.org/reference/destructors.html
6060
pub(crate) struct GuardConditionHandle {

0 commit comments

Comments
 (0)