feat: v1.13.4

Author: eastspire

Cargo.toml

@@ -1,10 +1,10 @@
 [package]
 name = "lombok-macros"
-version = "1.13.3"
+version = "1.13.4"
 edition = "2024"
 authors = ["root@ltpp.vip"]
 license = "MIT"
-description = """A collection of procedural macros for Lombok-like functionality in Rust."""
+description = """A Rust procedural macro collection providing Lombok-like functionality. Automatically generates getters/setters with field-level visibility control, custom Debug implementations with field skipping, and Display trait implementations. Supports structs, enums, generics and lifetimes."""
 keywords = ["proc-macro", "get-set", "macros", "lombok", "code-generation"]
 repository = "https://github.com/eastspire/lombok-macros.git"
 categories = ["development-tools"]

readme.md

@@ -14,7 +14,7 @@
 
 [Api Docs](https://docs.rs/lombok-macros/latest/lombok_macros/)
 
-> A collection of procedural macros for Lombok-like functionality in Rust.
+> A Rust procedural macro collection providing Lombok-like functionality. Automatically generates getters/setters with field-level visibility control, custom Debug implementations with field skipping, and Display trait implementations. Supports structs, enums, generics and lifetimes.
 
 ## Installation
 

src/cfg/impl.rs

@@ -1,6 +1,12 @@
 use crate::*;
 
+/// Provides default configuration values for the Cfg struct.
 impl Default for Cfg {
+    /// Returns a default `Cfg` instance with unknown function type, skip set to false, and public visibility.
+    ///
+    /// # Returns
+    ///
+    /// - `Cfg` - A new `Cfg` instance with default values.
     fn default() -> Self {
         Self {
             func_type: FuncType::Unknown,

src/cfg/struct.rs

@@ -11,7 +11,10 @@ use crate::{func::*, visibility::*};
 /// - `visibility`: A `Visibility` that defines the visibility of the function (e.g., `Public`, `Private`).
 #[derive(Debug, Clone, PartialEq, Eq)]
 pub struct Cfg {
+    /// A `FuncType` that specifies the function type (e.g., `Get`, `Set`, or `Unknown`).
     pub(crate) func_type: FuncType,
+    /// A boolean flag indicating whether the function should be skipped during processing.
     pub(crate) skip: bool,
+    /// A `Visibility` that defines the visibility of the function (e.g., `Public`, `Private`).
     pub(crate) visibility: Visibility,
 }

src/func/enum.rs

@@ -2,14 +2,20 @@
 ///
 /// # Variants
 /// - `Get`: Represents a getter function.
+/// - `GetMut`: Represents a mutable getter function.
 /// - `Set`: Represents a setter function.
 /// - `Debug`: Represents a debug function.
 /// - `Unknown`: Represents an unknown or unspecified function type.
 #[derive(Debug, Clone, PartialEq, Eq)]
 pub enum FuncType {
+    /// Represents a getter function.
     Get,
+    /// Represents a mutable getter function.
     GetMut,
+    /// Represents a setter function.
     Set,
+    /// Represents a debug function.
     Debug,
+    /// Represents an unknown or unspecified function type.
     Unknown,
 }

src/func/impl.rs

@@ -1,14 +1,27 @@
 use crate::*;
 
+/// Provides default implementation for FuncType.
 impl Default for FuncType {
+    /// Returns the default value for FuncType, which is Unknown.
     fn default() -> Self {
         Self::Unknown
     }
 }
 
+/// Implements the `FromStr` trait for `FuncType` to parse string representations into `FuncType` variants.
 impl FromStr for FuncType {
     type Err = String;
 
+    /// Parses a string slice into a `FuncType`.
+    ///
+    /// # Arguments
+    ///
+    /// - `s`: The string slice to parse.
+    ///
+    /// # Returns
+    ///
+    /// - `Result<FuncType, String>`: Ok containing the `FuncType` if parsing is successful,
+    ///   or an Err containing a String error message if parsing fails.
     fn from_str(s: &str) -> Result<FuncType, std::string::String> {
         match s {
             GET => Ok(FuncType::Get),
@@ -24,7 +37,7 @@ impl FuncType {
     /// Checks if the `FuncType` is `Get`.
     ///
     /// # Parameters
-    /// - `self`: The reference to the `FuncType` instance.
+    /// - `self` - The reference to the `FuncType` instance.
     ///
     /// # Returns
     /// - `true` if the `FuncType` is `Get`; otherwise, `false`.
@@ -35,7 +48,7 @@ impl FuncType {
     /// Checks if the `FuncType` is `GetMut`.
     ///
     /// # Parameters
-    /// - `self`: The reference to the `FuncType` instance.
+    /// - `self` - The reference to the `FuncType` instance.
     ///
     /// # Returns
     /// - `true` if the `FuncType` is `GetMut`; otherwise, `false`.
@@ -46,7 +59,7 @@ impl FuncType {
     /// Checks if the `FuncType` is `Set`.
     ///
     /// # Parameters
-    /// - `self`: The reference to the `FuncType` instance.
+    /// - `self` - The reference to the `FuncType` instance.
     ///
     /// # Returns
     /// - `true` if the `FuncType` is `Set`; otherwise, `false`.
@@ -57,7 +70,7 @@ impl FuncType {
     /// Checks if the `FuncType` is `Debug`.
     ///
     /// # Parameters
-    /// - `self`: The reference to the `FuncType` instance.
+    /// - `self` - The reference to the `FuncType` instance.
     ///
     /// # Returns
     /// - `true` if the `FuncType` is `Debug`; otherwise, `false`.
@@ -68,7 +81,7 @@ impl FuncType {
     /// Checks if the `FuncType` is `Unknown`.
     ///
     /// # Parameters
-    /// - `self`: The reference to the `FuncType` instance.
+    /// - `self` - The reference to the `FuncType` instance.
     ///
     /// # Returns
     /// - `true` if the `FuncType` is `Unknown`; otherwise, `false`.
@@ -79,10 +92,10 @@ impl FuncType {
     /// Checks if the `FuncType` is `Unknown`.
     ///
     /// # Parameters
-    /// - `self`: The reference to the `FuncType` instance.
+    /// - `func_type_str`: The string slice representing the function type to check.
     ///
     /// # Returns
-    /// - `true` if the `FuncType` is `Unknown`; otherwise, `false`.
+    /// - `true` if the `FuncType` parsed from the string is not `Unknown`; otherwise, `false`.
     pub fn is_known(func_type_str: &str) -> bool {
         let func_type: FuncType = func_type_str.parse::<FuncType>().unwrap_or_default();
         func_type != Self::Unknown

src/generate/const.rs

@@ -1,5 +1,10 @@
+/// Error message indicating that a field must have a name.
 pub const FIELD_SHOULD_HAVE_A_NAME: &str = "Field should have a name";
+/// Prefix for getter methods.
 pub const GET_METHOD_PREFIX: &str = "get_";
+/// Prefix for mutable getter methods.
 pub const GET_MUT_METHOD_PREFIX: &str = "get_mut_";
+/// Prefix for setter methods.
 pub const SET_METHOD_PREFIX: &str = "set_";
+/// Error message indicating that #[derive(Lombok)] is only supported for structs.
 pub const UNSUPPORTED_LOMBOK_DERIVE: &str = "#[derive(Lombok)] is only supported for structs.";