From 0fefbc509ec4d6a43a19f6a1191de8c49c55e376 Mon Sep 17 00:00:00 2001 From: Patrick Schurig Date: Sat, 8 Aug 2026 11:46:42 +0200 Subject: [PATCH] =?UTF-8?q?fix(doc):=20deux=20d=C3=A9fauts=20Doxygen=20r?= =?UTF-8?q?=C3=A9els=20dans=20etm/?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Corrections, pas ajouts. Les deux n'apparaissent que sous une configuration générant réellement une sortie (cf. Doxyfile) — ils étaient invisibles jusqu'ici. - loadconfigstore.h : « » dans le bloc de tête était interprété comme une balise xml/html non supportée, ce qui tronquait la description du format fichier. Reformulé sans chevrons. - sgreadyadapter.h : lockWindow() documentait « \param[out] minState / maxState » en une seule directive ; doxygen n'en reconnaissait aucune des deux et considérait « now » et « maxState » comme non documentés. Scindé en trois directives, une par paramètre. Aucun changement de comportement. Co-Authored-By: Claude Opus 5 (1M context) --- energyplugin/etm/adapters/sgreadyadapter.h | 7 +++++-- energyplugin/etm/config/loadconfigstore.h | 5 +++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/energyplugin/etm/adapters/sgreadyadapter.h b/energyplugin/etm/adapters/sgreadyadapter.h index 57dcb5b..cd8d433 100644 --- a/energyplugin/etm/adapters/sgreadyadapter.h +++ b/energyplugin/etm/adapters/sgreadyadapter.h @@ -91,8 +91,11 @@ public: private: /*! * \brief Fenêtre d'états autorisée à \p now par le verrou minStateHold (symétrique). - * \param[out] minState / maxState Gel total (== \c m_currentState) si \c minStateHold - * non écoulé ; sinon [min, max] des états déclarés. + * \param now Temps de cycle (\c ctx.timestamp) — jamais l'horloge. + * \param[out] minState Borne basse : \c m_currentState si \c minStateHold non écoulé + * (gel total), sinon le plus petit état déclaré. + * \param[out] maxState Borne haute : \c m_currentState si \c minStateHold non écoulé + * (gel total), sinon le plus grand état déclaré. */ void lockWindow(const QDateTime &now, int &minState, int &maxState) const; diff --git a/energyplugin/etm/config/loadconfigstore.h b/energyplugin/etm/config/loadconfigstore.h index 373b73f..548fda8 100644 --- a/energyplugin/etm/config/loadconfigstore.h +++ b/energyplugin/etm/config/loadconfigstore.h @@ -13,8 +13,9 @@ * energy-load-configuration.json, à côté de \c energy-manager-configuration.json) et émet * \c changed() — l'arbitre reconstruit ses adaptateurs sur ce signal, le handler notifie l'app. * - * Format fichier : \c {"version":1,"loads":[ , ... ]}. Le tableau \c loads[] - * est **mot pour mot** le \c LoadDescriptor §4 (jonction inter-repos avec l'app). + * Format fichier : \c {"version":1,"loads":[ ... ]}, chaque entrée étant un \c LoadConfig §4. + * Le tableau \c loads[] est **mot pour mot** le \c LoadDescriptor §4 (jonction inter-repos + * avec l'app). * * \invariant Écriture atomique (fichier temporaire + \c rename) — jamais de fichier mi-écrit. * \invariant \c setConfigs() rejette en bloc (rien persisté) si une seule entrée est invalide.