docs: Stop putting doc comments below attributes

Author: Serial-ATA

ogg_pager/src/lib.rs

@@ -276,7 +276,6 @@ impl Page {
 	}
 }
 
-#[allow(clippy::mixed_read_write_in_expression)]
 /// Create pages from a packet
 ///
 /// # Example
@@ -290,6 +289,7 @@ impl Page {
 ///
 /// let pages = paginate(&comment_header_packet, stream_serial_number, 0, 0);
 /// ```
+#[allow(clippy::mixed_read_write_in_expression)]
 pub fn paginate(packet: &[u8], stream_serial: u32, abgp: u64, flags: u8) -> Vec<Page> {
 	let mut pages = Vec::new();
 

src/ape/properties.rs

@@ -8,9 +8,9 @@ use std::time::Duration;
 
 use byteorder::{LittleEndian, ReadBytesExt};
 
+/// An APE file's audio properties
 #[derive(Clone, Debug, PartialEq, Eq, Default)]
 #[non_exhaustive]
-/// An APE file's audio properties
 pub struct ApeProperties {
 	pub(crate) version: u16,
 	pub(crate) duration: Duration,

src/ape/tag/item.rs

@@ -6,11 +6,11 @@ use crate::tag::TagType;
 
 use std::convert::TryFrom;
 
-#[derive(Debug, PartialEq, Eq, Clone)]
 /// Represents an `APE` tag item
 ///
 /// The restrictions for `APE` lie in the key rather than the value,
 /// so these are still able to use [`ItemValue`]s
+#[derive(Debug, PartialEq, Eq, Clone)]
 pub struct ApeItem {
 	/// Whether or not to mark the item as read only
 	pub read_only: bool,

src/error.rs

@@ -13,9 +13,9 @@ use ogg_pager::PageError;
 /// Alias for `Result<T, LoftyError>`
 pub type Result<T> = std::result::Result<T, LoftyError>;
 
+/// The types of errors that can occur
 #[derive(Debug)]
 #[non_exhaustive]
-/// The types of errors that can occur
 pub enum ErrorKind {
 	// File format related errors
 	/// Unable to guess the format
@@ -66,9 +66,9 @@ pub enum ErrorKind {
 	Alloc(TryReserveError),
 }
 
+/// The types of errors that can occur while interacting with ID3v2 tags
 #[derive(Debug, Clone)]
 #[non_exhaustive]
-/// The types of errors that can occur while interacting with ID3v2 tags
 pub enum ID3v2ErrorKind {
 	#[cfg(feature = "id3v2")]
 	/// Arises when an invalid picture format is parsed. Only applicable to [`ID3v2Version::V2`](crate::id3::v2::ID3v2Version::V2)

src/file.rs

@@ -477,10 +477,10 @@ impl AudioFile for TaggedFile {
 	}
 }
 
+/// The type of file read
 #[derive(PartialEq, Eq, Copy, Clone, Debug)]
 #[allow(missing_docs)]
 #[non_exhaustive]
-/// The type of file read
 pub enum FileType {
 	AAC,
 	AIFF,

src/id3/v1/constants.rs

@@ -1,5 +1,5 @@
-#[cfg(any(feature = "id3v1", feature = "mp4_ilst"))]
 /// All possible genres for ID3v1
+#[cfg(any(feature = "id3v1", feature = "mp4_ilst"))]
 pub const GENRES: [&str; 192] = [
 	"Blues",
 	"Classic rock",

src/id3/v2/flags.rs

@@ -1,9 +1,9 @@
 #[cfg(feature = "id3v2_restrictions")]
 use super::restrictions::TagRestrictions;
 
+/// Flags that apply to the entire tag
 #[derive(Default, Copy, Clone, Debug, PartialEq, Eq)]
 #[allow(clippy::struct_excessive_bools)]
-/// Flags that apply to the entire tag
 pub struct ID3v2TagFlags {
 	/// Whether or not all frames are unsynchronised. See [`FrameFlags::unsynchronisation`](crate::id3::v2::FrameFlags::unsynchronisation)
 	pub unsynchronisation: bool,

src/id3/v2/items/encapsulated_object.rs

@@ -3,8 +3,8 @@ use crate::util::text::{decode_text, encode_text, TextEncoding};
 
 use std::io::{Cursor, Read};
 
-#[derive(PartialEq, Clone, Debug, Eq, Hash)]
 /// Information about a [`GeneralEncapsulatedObject`]
+#[derive(PartialEq, Clone, Debug, Eq, Hash)]
 pub struct GEOBInformation {
 	/// The text encoding of `file_name` and `description`
 	pub encoding: TextEncoding,

src/id3/v2/items/sync_text.rs

@@ -6,9 +6,9 @@ use std::io::{Cursor, Read, Seek, SeekFrom, Write};
 
 use byteorder::{BigEndian, ReadBytesExt, WriteBytesExt};
 
+/// The unit used for [`SynchronizedText`] timestamps
 #[derive(Copy, Clone, PartialEq, Debug, Eq, Hash)]
 #[repr(u8)]
-/// The unit used for [`SynchronizedText`] timestamps
 pub enum TimestampFormat {
 	/// The unit is MPEG frames
 	MPEG = 1,
@@ -27,10 +27,10 @@ impl TimestampFormat {
 	}
 }
 
+/// The type of text stored in a [`SynchronizedText`]
 #[derive(Copy, Clone, PartialEq, Debug, Eq, Hash)]
 #[repr(u8)]
 #[allow(missing_docs)]
-/// The type of text stored in a [`SynchronizedText`]
 pub enum SyncTextContentType {
 	Other = 0,
 	Lyrics = 1,
@@ -61,8 +61,8 @@ impl SyncTextContentType {
 	}
 }
 
-#[derive(PartialEq, Clone, Debug, Eq, Hash)]
 /// Information about a [`SynchronizedText`]
+#[derive(PartialEq, Clone, Debug, Eq, Hash)]
 pub struct SyncTextInformation {
 	/// The text encoding (description/text)
 	pub encoding: TextEncoding,

src/id3/v2/mod.rs

@@ -55,8 +55,8 @@ cfg_if::cfg_if! {
 #[cfg(not(feature = "id3v2"))]
 use flags::ID3v2TagFlags;
 
-#[derive(PartialEq, Eq, Debug, Clone, Copy)]
 /// The ID3v2 version
+#[derive(PartialEq, Eq, Debug, Clone, Copy)]
 pub enum ID3v2Version {
 	/// ID3v2.2
 	V2,