fix docs

Signed-off-by: Illyrius <fitimq@live.nl>

Author: Illyrius

src/config.rs

@@ -10,26 +10,8 @@ use std::{fs, io};
 /// the `PlayerModuleConfig` configuration.
 ///
 /// # Attributes
-///
 /// * `player_module` - A public field of type `PlayerModuleConfig` that holds
 ///   the configuration details for the player module.
-///
-/// # Derives
-///
-/// This struct derives the following traits:
-/// - `Clone`: Enables the `ConfigManager` to be cloned.
-/// - `Debug`: Provides the ability to format the `ConfigManager` for debugging purposes.
-/// - `Default`: Allows the creation of a default instance of `ConfigManager`.
-/// - `Serialize`: Enables serialization of the `ConfigManager` into formats such as JSON.
-/// - `Deserialize`: Allows deserialization of the `ConfigManager` from formats such as JSON.
-///
-/// # Example
-/// ```
-/// use your_crate_name::ConfigManager;
-///
-/// let default_config = ConfigManager::default();
-/// println!("{:?}", default_config);
-/// ```
 #[derive(Clone, Debug, Default, Serialize, Deserialize)]
 pub struct ConfigManager {
     pub player_module: Config,
@@ -38,34 +20,14 @@ pub struct ConfigManager {
 impl ConfigManager {
     /// Creates a new instance of the configuration.
     ///
-    /// This function attempts to load an existing configuration file from the path
-    /// determined by the `path` function. If the file does not exist, it creates a
-    /// default configuration, saves it at the specified path, and returns the default configuration.
-    ///
     /// # Arguments
-    ///
     /// * `ctx` - An `Arc<Context>` instance, which provides the necessary context
     ///           to determine the file path for the configuration.
     ///
     /// # Returns
-    ///
     /// * `Ok(Self)` - If the configuration is successfully loaded or created as default.
     /// * `Err(io::Error)` - If an I/O error occurs during the loading or saving process,
     ///                      other than a `NotFound` error.
-    ///
-    /// # Errors
-    ///
-    /// * Returns an error if:
-    ///   - Loading the configuration file fails for reasons other than the file being
-    ///     not found.
-    ///   - Saving the default configuration fails.
-    ///
-    /// # Example
-    ///
-    /// ```rust
-    /// let context = Arc::new(Context::new());
-    /// let config = ConfigManager::new(context).expect("Failed to create configuration");
-    /// ```
     pub fn new(ctx: Arc<Context>) -> Result<Self, io::Error> {
         let path = Self::path(ctx.clone());
 
@@ -82,25 +44,9 @@ impl ConfigManager {
 
     /// Generates the file path for the configuration file.
     ///
-    /// This function constructs the full file path to the `config.json` file
-    /// located in the data folder of the provided context.
-    ///
     /// # Arguments
-    ///
     /// * `ctx` - An `Arc<Context>` object that provides access to the application's
     ///           data folder through its `get_data_folder` method.
-    ///
-    /// # Returns
-    ///
-    /// A `PathBuf` representing the full path to the `config.json` file.
-    ///
-    /// # Example
-    ///
-    /// ```rust
-    /// let context = Arc::new(Context::new());
-    /// let config_path = path(context);
-    /// println!("{:?}", config_path); // Outputs: /path/to/data_folder/config.json
-    /// ```
     fn path(ctx: Arc<Context>) -> PathBuf {
         ctx.get_data_folder().join("config.json")
     }
@@ -121,7 +67,6 @@ impl ConfigManager {
     }
 
     /// Saves the current object to the specified file path in a JSON format.
-    /// If necessary, creates any parent directories for the file path.
     ///
     /// # Parameters
     /// - `path`: A reference to a [`Path`] where the object should be saved.
@@ -130,25 +75,6 @@ impl ConfigManager {
     /// - `Result<(), io::Error>`:
     ///     - `Ok(())` if the object is successfully saved.
     ///     - An `io::Error` if an error occurs during the serialization or file operations.
-    ///
-    /// # Errors
-    /// - Returns an `io::Error` if:
-    ///     - Parent directories cannot be created.
-    ///     - The object cannot be serialized into JSON (e.g., due to invalid data).
-    ///     - The JSON content cannot be written to the file system.
-    ///
-    /// # Examples
-    /// ```rust
-    /// use std::path::Path;
-    /// use std::fs;
-    ///
-    /// let my_obj = MyStruct::new();
-    /// let path = Path::new("output/my_file.json");
-    ///
-    /// if let Err(e) = my_obj.save(&path) {
-    ///     eprintln!("Failed to save object: {}", e);
-    /// }
-    /// ```
     fn save(&self, path: &Path) -> Result<(), io::Error> {
         if let Some(parent) = path.parent() {
             fs::create_dir_all(parent)?;