[#100] Fix clippy and doc warnings

iceoryx2/src/port/listener.rs

@@ -45,7 +45,7 @@ use std::time::Duration;
 
 use super::event_id::EventId;
 
-/// Defines the failures that can occur when a [`Listen`]er is created with the
+/// Defines the failures that can occur when a [`Listener`] is created with the
 /// [`crate::service::port_factory::listener::PortFactoryListener`].
 #[derive(Debug, PartialEq, Eq, Copy, Clone)]
 pub enum ListenerCreateError {
@@ -132,8 +132,8 @@ impl<Service: service::Service> Listener<Service> {
         Ok(())
     }
 
-    /// Returns the cached [`EventId`]s. Whenever [`Listen::try_wait()`],
-    /// [`Listen::timed_wait()`] or [`Listen::blocking_wait()`] is called the cache is reset
+    /// Returns the cached [`EventId`]s. Whenever [`Listener::try_wait()`],
+    /// [`Listener::timed_wait()`] or [`Listener::blocking_wait()`] is called the cache is reset
     /// and filled with the events that where signaled since the last call. This cache can be
     /// accessed until a new wait call resets and fills it again.
     pub fn cache(&self) -> &[EventId] {

iceoryx2/src/port/notifier.rs

@@ -48,7 +48,7 @@ use iceoryx2_cal::named_concept::NamedConceptBuilder;
 use iceoryx2_cal::{dynamic_storage::DynamicStorage, event::NotifierBuilder};
 use std::{cell::UnsafeCell, rc::Rc};
 
-/// Failures that can occur when a new [`Notify`]er is created with the
+/// Failures that can occur when a new [`Notifier`] is created with the
 /// [`crate::service::port_factory::notifier::PortFactoryNotifier`].
 #[derive(Debug, PartialEq, Eq, Copy, Clone)]
 pub enum NotifierCreateError {
@@ -63,7 +63,7 @@ impl std::fmt::Display for NotifierCreateError {
 
 impl std::error::Error for NotifierCreateError {}
 
-/// Defines the failures that can occur while a [`Notify::notify()`] call.
+/// Defines the failures that can occur while a [`Notifier::notify()`] call.
 #[derive(Debug, PartialEq, Eq, Copy, Clone)]
 pub enum NotifierConnectionUpdateFailure {
     OnlyPartialUpdate,

iceoryx2/src/port/publisher.rs

@@ -408,7 +408,6 @@ impl<Service: service::Service, MessageType: Debug> Publisher<Service, MessageTy
     /// [`crate::port::subscriber::Subscriber`] is corrupted or a seems to be dead, this callback
     /// is called and depending on the returned [`DegrationAction`] measures will be taken.
     pub fn set_degration_callback<
-        'publisher,
         F: Fn(
                 service::static_config::StaticConfig,
                 UniquePublisherId,

iceoryx2/src/port/subscriber.rs

@@ -53,7 +53,7 @@ use super::port_identifiers::{UniquePublisherId, UniqueSubscriberId};
 use super::update_connections::ConnectionFailure;
 use super::DegrationCallback;
 
-/// Defines the failure that can occur when receiving data with [`Subscribe::receive()`].
+/// Defines the failure that can occur when receiving data with [`Subscriber::receive()`].
 #[derive(Debug, PartialEq, Eq, Copy, Clone)]
 pub enum SubscriberReceiveError {
     ExceedsMaxBorrowedSamples,
@@ -68,7 +68,7 @@ impl std::fmt::Display for SubscriberReceiveError {
 
 impl std::error::Error for SubscriberReceiveError {}
 
-/// Describes the failures when a new [`Subscribe`] is created via the
+/// Describes the failures when a new [`Subscriber`] is created via the
 /// [`crate::service::port_factory::subscriber::PortFactorySubscriber`].
 #[derive(Debug, PartialEq, Eq, Copy, Clone)]
 pub enum SubscriberCreateError {
@@ -212,8 +212,8 @@ impl<Service: service::Service, MessageType: Debug> Subscriber<Service, MessageT
         Ok(())
     }
 
-    fn receive_from_connection<'subscriber>(
-        &'subscriber self,
+    fn receive_from_connection(
+        &self,
         channel_id: usize,
         connection: &mut Connection<Service>,
     ) -> Result<Option<Sample<MessageType, Service>>, SubscriberReceiveError> {

iceoryx2/src/sample.rs

@@ -46,7 +46,7 @@ use crate::service::header::publish_subscribe::Header;
 
 /// It stores the payload and is acquired by the [`crate::port::subscriber::Subscriber`] whenever
 /// it receives new data from a [`crate::port::publisher::Publisher`] via
-/// [`crate::port::subscribe::Subscribe::receive()`].
+/// [`crate::port::subscriber::Subscriber::receive()`].
 #[derive(Debug)]
 pub struct Sample<MessageType: Debug, Service: crate::service::Service> {
     pub(crate) publisher_connections: Rc<PublisherConnections<Service>>,

iceoryx2/src/service/port_factory/notifier.rs

@@ -55,7 +55,7 @@ impl<'factory, Service: service::Service> PortFactoryNotifier<'factory, Service>
     }
 
     /// Sets a default [`EventId`] for the [`Notifier`] that is used in
-    /// [`crate::port::notify::Notify::notify()`]
+    /// [`Notifier::notify()`]
     pub fn default_event_id(mut self, value: EventId) -> Self {
         self.default_event_id = value;
         self