Skip to content

Commit

Permalink
Fix a doc issue
Browse files Browse the repository at this point in the history
  • Loading branch information
TTWNO committed Dec 17, 2024
1 parent af7fb89 commit b116f84
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 16 deletions.
8 changes: 4 additions & 4 deletions atspi-common/src/events/event_wrappers.rs
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ pub enum DocumentEvents {
LoadStopped(LoadStoppedEvent),
/// See: [`ContentChangedEvent`].
ContentChanged(ContentChangedEvent),
/// See: [`AttributesChangedEvent`].
/// See: [`DocumentAttributesChangedEvent`].
AttributesChanged(DocumentAttributesChangedEvent),
/// See: [`PageChangedEvent`].
PageChanged(PageChangedEvent),
Expand Down Expand Up @@ -368,7 +368,7 @@ impl EventProperties for Event {

#[derive(Clone, Debug, serde::Serialize, serde::Deserialize, PartialEq, Eq, Hash)]
pub enum ObjectEvents {
/// See: [`PropertyChangeEvent`].
/// See: [`ObjectPropertyChangeEvent`].
PropertyChange(ObjectPropertyChangeEvent),
/// See: [`BoundsChangedEvent`].
BoundsChanged(BoundsChangedEvent),
Expand All @@ -388,7 +388,7 @@ pub enum ObjectEvents {
ActiveDescendantChanged(ActiveDescendantChangedEvent),
/// See: [`AnnouncementEvent`].
Announcement(AnnouncementEvent),
/// See: [`AttributesChangedEvent`].
/// See: [`ObjectAttributesChangedEvent`].
AttributesChanged(ObjectAttributesChangedEvent),
/// See: [`RowInsertedEvent`].
RowInserted(RowInsertedEvent),
Expand Down Expand Up @@ -1537,7 +1537,7 @@ impl_try_from_event_for_user_facing_type!(
/// All events on the `org.a11y.atspi.Event.Window` interface.
#[derive(Clone, Debug, serde::Serialize, serde::Deserialize, PartialEq, Eq, Hash)]
pub enum WindowEvents {
/// See: [`PropertyChangeEvent`].
/// See: [`WindowPropertyChangeEvent`].
PropertyChange(WindowPropertyChangeEvent),
/// See: [`MinimizeEvent`].
Minimize(MinimizeEvent),
Expand Down
24 changes: 12 additions & 12 deletions atspi-common/src/events/traits.rs
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ use zvariant::Type;
/// Likewise, the path and sender bus name collectively make up an [`ObjectRef`], which is a way to uniquely identify an individual accessible item available to `atspi`.
/// The latter is available via the [`EventProperties`] trait.
///
/// This can also be generalized, for example this is implemented for [`Event`] by dispatching to the matching variants.
/// This can also be generalized, for example this is implemented for [`crate::Event`] by dispatching to the matching variants.
/// NOTE: to use `EventProperties` on wrapper types, like `Event`, you must enable the "enum-dispatch" feature.
///
/// This trait *is* object-safe.
Expand Down Expand Up @@ -54,10 +54,10 @@ pub trait EventProperties {
/// For a similar, but object-safe trait, see [`EventProperties`].
pub trait BusProperties {
/// The `DBus` member for the event.
/// For example, for an [`object::TextChangedEvent`] this should be `"TextChanged"`
/// For example, for an [`crate::events::object::TextChangedEvent`] this should be `"TextChanged"`
const DBUS_MEMBER: &'static str;
/// The `DBus` interface name for this event.
/// For example, for any event within [`object`], this should be "org.a11y.atspi.Event.Object".
/// For example, for any event within [`crate::events::object`], this should be "org.a11y.atspi.Event.Object".
const DBUS_INTERFACE: &'static str;
/// A static match rule string for `DBus`.
/// This should usually be a string that looks like this: `"type='signal',interface='org.a11y.atspi.Event.Object',member='PropertyChange'"`;
Expand All @@ -69,9 +69,9 @@ pub trait BusProperties {
}

/// A specific trait *only* to define an interface name.
/// This is useful for event wrappers like [`ObjectEvents`], which, while it does not have other
/// information required to implement the [`BusProperties`] trait, you can indeed attach in
/// interface name for all sub events of [`ObjectEvents`].
/// This is useful for event wrappers like [`crate::events::ObjectEvents`], which, while it does not have other
/// information required to implement the [`crate::BusProperties`] trait, you can indeed attach in
/// interface name for all sub events of [`crate::events::ObjectEvents`].
///
/// This trait *is not* object-safe.
pub trait HasInterfaceName {
Expand All @@ -81,9 +81,9 @@ pub trait HasInterfaceName {
}

/// A specific trait *only* to define match rules.
/// This is useful for event wrappers like [`ObjectEvents`], which, while it does not have other
/// information required to implement the [`BusProperties`] trait, you can indeed add a match rule
/// to the `DBus` connection to capture all sub events of [`ObjectEvents`].
/// This is useful for event wrappers like [`crate::events::ObjectEvents`], which, while it does not have other
/// information required to implement the [`crate::BusProperties`] trait, you can indeed add a match rule
/// to the `DBus` connection to capture all sub events of [`crate::events::ObjectEvents`].
///
/// This trait *is not* object-safe.
pub trait HasMatchRule {
Expand All @@ -94,9 +94,9 @@ pub trait HasMatchRule {
}

/// A specific trait *only* to define registry event matches.
/// This is useful for event wrappers like [`ObjectEvents`], which, while it does not have other
/// information required to implement the [`BusProperties`] trait, you can indeed add a match rule
/// to the AT-SPI connection to subscribe to all sub events of [`ObjectEvents`].
/// This is useful for event wrappers like [`crate::events::ObjectEvents`], which, while it does not have other
/// information required to implement the [`crate::BusProperties`] trait, you can indeed add a match rule
/// to the AT-SPI connection to subscribe to all sub events of [`crate::events::ObjectEvents`].
///
/// This trait *is not* object-safe.
pub trait HasRegistryEventString {
Expand Down

0 comments on commit b116f84

Please sign in to comment.