doc: add doc comments to ctalog struct description

This commit is contained in:
2025-10-09 15:34:01 +02:00
parent 5ec071ce63
commit 63ecb15824

View File

@@ -1,11 +1,14 @@
use crate::*; use crate::*;
/// Represents a catalog of entities that can be persisted to a SQLite database.
///
/// The `Catalog` holds entities in memory and provides methods to interact with
/// them, as well as to persist changes to and load data from a database file.
#[derive(Debug, Default, PartialEq, Clone)] #[derive(Debug, Default, PartialEq, Clone)]
pub struct O { pub struct O {
path: String, path: String,
pub(crate) items: std::collections::HashMap<String, Entity>, pub(crate) items: std::collections::HashMap<String, Entity>,
} }
impl O { impl O {
/// Creates a new `Catalog` instance. /// Creates a new `Catalog` instance.
/// ///