clippy shorter type docs

This commit is contained in:
Christopher Sieh 2024-08-30 11:01:33 +02:00
parent cecc6702f3
commit 52005e6278
1 changed files with 10 additions and 19 deletions

View File

@ -1,7 +1,7 @@
//! Predefined point types commonly used in ROS. //! Predefined point types commonly used in ROS.
use crate::{LayoutDescription, LayoutField, PointConvertible, RPCL2Point}; use crate::{LayoutDescription, LayoutField, PointConvertible, RPCL2Point};
/// A packed RGB color encoding as used in ROS tools. /// Packed RGB color encoding as used in ROS tools.
#[derive(Clone, Copy)] #[derive(Clone, Copy)]
#[repr(C, align(4))] #[repr(C, align(4))]
pub union RGB { pub union RGB {
@ -103,8 +103,7 @@ impl From<f32> for RGB {
} }
} }
/// Predefined point type commonly used in ROS with PCL. /// 3D point with x, y, z coordinates, commonly used in ROS with PCL.
/// This is a 3D point with x, y, z coordinates.
#[derive(Clone, Debug, PartialEq, Copy, Default)] #[derive(Clone, Debug, PartialEq, Copy, Default)]
#[repr(C, align(16))] #[repr(C, align(16))]
pub struct PointXYZ { pub struct PointXYZ {
@ -171,8 +170,7 @@ unsafe impl PointConvertible<3> for PointXYZ {
} }
} }
/// Predefined point type commonly used in ROS with PCL. /// 3D point with x, y, z coordinates and an intensity value, commonly used in ROS with PCL.
/// This is a 3D point with x, y, z coordinates and an intensity value.
#[derive(Clone, Debug, PartialEq, Copy, Default)] #[derive(Clone, Debug, PartialEq, Copy, Default)]
#[repr(C, align(16))] #[repr(C, align(16))]
pub struct PointXYZI { pub struct PointXYZI {
@ -232,8 +230,7 @@ unsafe impl PointConvertible<4> for PointXYZI {
} }
} }
/// Predefined point type commonly used in ROS with PCL. /// 3D point with x, y, z coordinates and a label, commonly used in ROS with PCL.
/// This is a 3D point with x, y, z coordinates and a label.
#[derive(Clone, Debug, PartialEq, Copy, Default)] #[derive(Clone, Debug, PartialEq, Copy, Default)]
#[repr(C, align(16))] #[repr(C, align(16))]
pub struct PointXYZL { pub struct PointXYZL {
@ -293,8 +290,7 @@ unsafe impl PointConvertible<4> for PointXYZL {
} }
} }
/// Predefined point type commonly used in ROS with PCL. /// 3D point with x, y, z coordinates and an RGB color value, commonly used in ROS with PCL.
/// This is a 3D point with x, y, z coordinates and an RGB color value.
#[derive(Clone, Debug, PartialEq, Copy, Default)] #[derive(Clone, Debug, PartialEq, Copy, Default)]
#[repr(C, align(16))] #[repr(C, align(16))]
pub struct PointXYZRGB { pub struct PointXYZRGB {
@ -371,8 +367,7 @@ unsafe impl PointConvertible<4> for PointXYZRGB {
} }
} }
/// Predefined point type commonly used in ROS with PCL. /// 3D point with x, y, z coordinates and an RGBA color value, commonly used in ROS with PCL.
/// This is a 3D point with x, y, z coordinates and an RGBA color value.
/// The alpha channel is commonly used as padding but this crate uses every channel and no padding. /// The alpha channel is commonly used as padding but this crate uses every channel and no padding.
#[derive(Clone, Debug, PartialEq, Copy, Default)] #[derive(Clone, Debug, PartialEq, Copy, Default)]
#[repr(C, align(16))] #[repr(C, align(16))]
@ -455,8 +450,7 @@ unsafe impl PointConvertible<5> for PointXYZRGBA {
} }
} }
/// Predefined point type commonly used in ROS with PCL. /// 3D point with x, y, z coordinates, an RGB color value and a normal vector, commonly used in ROS with PCL.
/// This is a 3D point with x, y, z coordinates, an RGB color value and a normal vector.
#[derive(Clone, Debug, PartialEq, Copy, Default)] #[derive(Clone, Debug, PartialEq, Copy, Default)]
#[repr(C, align(16))] #[repr(C, align(16))]
pub struct PointXYZRGBNormal { pub struct PointXYZRGBNormal {
@ -561,8 +555,7 @@ unsafe impl PointConvertible<7> for PointXYZRGBNormal {
} }
} }
/// Predefined point type commonly used in ROS with PCL. /// 3D point with x, y, z coordinates, an intensity value and a normal vector, commonly used in ROS with PCL.
/// This is a 3D point with x, y, z coordinates, an intensity value and a normal vector.
#[derive(Clone, Debug, PartialEq, Copy, Default)] #[derive(Clone, Debug, PartialEq, Copy, Default)]
#[repr(C, align(16))] #[repr(C, align(16))]
pub struct PointXYZINormal { pub struct PointXYZINormal {
@ -652,8 +645,7 @@ unsafe impl PointConvertible<7> for PointXYZINormal {
} }
} }
/// Predefined point type commonly used in ROS with PCL. /// 3D point with x, y, z coordinates and a label, commonly used in ROS with PCL.
/// This is a 3D point with x, y, z coordinates and a label.
#[derive(Clone, Debug, PartialEq, Copy, Default)] #[derive(Clone, Debug, PartialEq, Copy, Default)]
#[repr(C, align(16))] #[repr(C, align(16))]
pub struct PointXYZRGBL { pub struct PointXYZRGBL {
@ -741,8 +733,7 @@ unsafe impl PointConvertible<5> for PointXYZRGBL {
} }
} }
/// Predefined point type commonly used in ROS with PCL. /// 3D point with x, y, z coordinates and a normal vector, commonly used in ROS with PCL.
/// This is a 3D point with x, y, z coordinates and a normal vector.
#[derive(Clone, Debug, PartialEq, Copy, Default)] #[derive(Clone, Debug, PartialEq, Copy, Default)]
#[repr(C, align(16))] #[repr(C, align(16))]
pub struct PointXYZNormal { pub struct PointXYZNormal {