From 4e5b8a9148fbe0305c7539b4eef9601c149719bf Mon Sep 17 00:00:00 2001 From: Claude Date: Wed, 5 Nov 2025 20:54:07 +0000 Subject: [PATCH] =?UTF-8?q?Am=C3=A9liorer=20la=20documentation=20des=20fon?= =?UTF-8?q?ctions=20singleton=20de=20cache?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Ajouter sections # Arguments et # Returns - Documenter le comportement thread-safe - Préciser le comportement en cas d'appels multiples - Ajouter liens croisés entre register_* et get_* --- pmoaudiocache/src/lib.rs | 22 ++++++++++++++++++++++ pmocovers/src/lib.rs | 22 ++++++++++++++++++++++ 2 files changed, 44 insertions(+) diff --git a/pmoaudiocache/src/lib.rs b/pmoaudiocache/src/lib.rs index 5b65f018..61dfa085 100755 --- a/pmoaudiocache/src/lib.rs +++ b/pmoaudiocache/src/lib.rs @@ -114,6 +114,16 @@ static AUDIO_CACHE: OnceCell> = OnceCell::new(); /// Cette fonction doit être appelée au démarrage de l'application /// pour rendre le cache audio disponible globalement. /// +/// # Arguments +/// +/// * `cache` - Instance partagée du cache audio à enregistrer +/// +/// # Behavior +/// +/// - Si appelée plusieurs fois, seul le premier appel prend effet +/// - Thread-safe: peut être appelée depuis plusieurs threads simultanément +/// - Une fois enregistré, le cache est accessible via [`get_audio_cache`] +/// /// # Examples /// /// ```rust,ignore @@ -129,6 +139,18 @@ pub fn register_audio_cache(cache: Arc) { /// Accès global au cache audio /// +/// Retourne une référence au cache audio enregistré via [`register_audio_cache`], +/// ou `None` si aucun cache n'a été enregistré. +/// +/// # Returns +/// +/// * `Some(Arc)` - Instance partagée du cache audio si enregistré +/// * `None` - Si aucun cache n'a été enregistré +/// +/// # Thread Safety +/// +/// Cette fonction est thread-safe et peut être appelée depuis plusieurs threads. +/// /// # Examples /// /// ```rust,ignore diff --git a/pmocovers/src/lib.rs b/pmocovers/src/lib.rs index a9e2cd5b..bc283057 100644 --- a/pmocovers/src/lib.rs +++ b/pmocovers/src/lib.rs @@ -82,6 +82,16 @@ static COVER_CACHE: OnceCell> = OnceCell::new(); /// Cette fonction doit être appelée au démarrage de l'application /// pour rendre le cache de couvertures disponible globalement. /// +/// # Arguments +/// +/// * `cache` - Instance partagée du cache de couvertures à enregistrer +/// +/// # Behavior +/// +/// - Si appelée plusieurs fois, seul le premier appel prend effet +/// - Thread-safe: peut être appelée depuis plusieurs threads simultanément +/// - Une fois enregistré, le cache est accessible via [`get_cover_cache`] +/// /// # Examples /// /// ```rust,ignore @@ -97,6 +107,18 @@ pub fn register_cover_cache(cache: Arc) { /// Accès global au cache de couvertures /// +/// Retourne une référence au cache de couvertures enregistré via [`register_cover_cache`], +/// ou `None` si aucun cache n'a été enregistré. +/// +/// # Returns +/// +/// * `Some(Arc)` - Instance partagée du cache de couvertures si enregistré +/// * `None` - Si aucun cache n'a été enregistré +/// +/// # Thread Safety +/// +/// Cette fonction est thread-safe et peut être appelée depuis plusieurs threads. +/// /// # Examples /// /// ```rust,ignore