fix(doc): deux défauts Doxygen réels dans etm/

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 : « <LoadConfig §4> » 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) <noreply@anthropic.com>
This commit is contained in:
Patrick Schurig 2026-08-08 11:46:42 +02:00
parent 06e01363d9
commit 0fefbc509e
2 changed files with 8 additions and 4 deletions

View File

@ -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;

View File

@ -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":[ <LoadConfig §4>, ... ]}. 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.