docs(doxygen): 0 avertissement — membres non documentés et balise échappée (DoD §5)
Neuf avertissements Doxygen sur etm/ (DoD §5 : zéro) : - AcLimitMaxW, \return de forecastAcLimitW(), ForecastPlanLu::planThingId (depuis 6b66d49) ; - \return de knownCodes() et optimizerEmittableCodes(), \param d'optimizerMayEmit() (50a1f91) ; - « <motif publié> » lu comme balise HTML (e6ee513), échappé. Commentaires seulement : aucune ligne de code modifiée. gen-doc.sh → 0 avertissement. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
parent
f2f65980b3
commit
26c0e02118
@ -161,12 +161,15 @@ public:
|
|||||||
* \brief Plafond AC (onduleur) du site désigné, en W. \c std::nullopt = aucun plafond.
|
* \brief Plafond AC (onduleur) du site désigné, en W. \c std::nullopt = aucun plafond.
|
||||||
* \note Un paramètre de SITE, pas de plan (§28 décision 2) : l'écrêtage porte sur ce que
|
* \note Un paramètre de SITE, pas de plan (§28 décision 2) : l'écrêtage porte sur ce que
|
||||||
* l'onduleur reçoit de tous ses champs. Appliqué après la somme, jamais 0.
|
* l'onduleur reçoit de tous ses champs. Appliqué après la somme, jamais 0.
|
||||||
|
* \return Le plafond en W, ou \c std::nullopt si aucun plafond n'est configuré.
|
||||||
*/
|
*/
|
||||||
std::optional<int> forecastAcLimitW() const { return m_forecastAcLimitW; }
|
std::optional<int> forecastAcLimitW() const { return m_forecastAcLimitW; }
|
||||||
|
|
||||||
//! Bornes acceptées pour \c acLimitW, en W. Sous 100 W : très probablement des kW saisis
|
//! Borne basse acceptée pour \c acLimitW, en W. Sous 100 W : très probablement des kW saisis
|
||||||
//! en W ; au-delà de 1 MW : hors du périmètre d'un site résidentiel ou tertiaire.
|
//! en W.
|
||||||
static constexpr int AcLimitMinW = 100;
|
static constexpr int AcLimitMinW = 100;
|
||||||
|
//! Borne haute acceptée pour \c acLimitW, en W. Au-delà de 1 MW : hors du périmètre d'un site
|
||||||
|
//! résidentiel ou tertiaire.
|
||||||
static constexpr int AcLimitMaxW = 1000000;
|
static constexpr int AcLimitMaxW = 1000000;
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
@ -212,7 +215,7 @@ public:
|
|||||||
|
|
||||||
//! Un plan SOMMÉ, tel qu'il a été lu : son Thing et les corrections qu'il déclare.
|
//! Un plan SOMMÉ, tel qu'il a été lu : son Thing et les corrections qu'il déclare.
|
||||||
struct ForecastPlanLu {
|
struct ForecastPlanLu {
|
||||||
QString planThingId;
|
QString planThingId; //!< ThingId du plan, forme canonique \c {uuid} minuscules
|
||||||
QStringList corrections; //!< ordre canonique ; vide = conversion brute
|
QStringList corrections; //!< ordre canonique ; vide = conversion brute
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|||||||
@ -395,6 +395,7 @@ constexpr const char *SafeStateSgReady = "SAFE_STATE_SG_READY";
|
|||||||
* \brief Tous les codes du catalogue, dans l'ordre de déclaration.
|
* \brief Tous les codes du catalogue, dans l'ordre de déclaration.
|
||||||
* \note Confrontée à CET EN-TÊTE par un test (loadmodel) : une constante sans entrée ici, ou sans
|
* \note Confrontée à CET EN-TÊTE par un test (loadmodel) : une constante sans entrée ici, ou sans
|
||||||
* branche de rendu, le fait échouer. « Connu du catalogue » se lit ici, nulle part ailleurs.
|
* branche de rendu, le fait échouer. « Connu du catalogue » se lit ici, nulle part ailleurs.
|
||||||
|
* \return Les codes du catalogue, sans doublon, dans l'ordre de déclaration.
|
||||||
*/
|
*/
|
||||||
QStringList knownCodes();
|
QStringList knownCodes();
|
||||||
|
|
||||||
@ -407,10 +408,14 @@ QStringList knownCodes();
|
|||||||
* réserve batterie, dérogation, obligation tenue ou manquée, recrédit — ce sont des faits que le
|
* réserve batterie, dérogation, obligation tenue ou manquée, recrédit — ce sont des faits que le
|
||||||
* moteur constate, et un optimiseur qui les publierait ferait mentir l'écran sur ce qui protège.
|
* moteur constate, et un optimiseur qui les publierait ferait mentir l'écran sur ce qui protège.
|
||||||
* Tout autre code devient \c OPTIMIZER_DECISION, sans paramètres.
|
* Tout autre code devient \c OPTIMIZER_DECISION, sans paramètres.
|
||||||
|
* \return Les codes autorisés pour un optimiseur, tous présents dans \c knownCodes().
|
||||||
*/
|
*/
|
||||||
QStringList optimizerEmittableCodes();
|
QStringList optimizerEmittableCodes();
|
||||||
|
|
||||||
//! \return Vrai si \p code est dans \c optimizerEmittableCodes().
|
/*!
|
||||||
|
* \param code Code de motif reçu d'un optimiseur.
|
||||||
|
* \return Vrai si \p code est dans \c optimizerEmittableCodes().
|
||||||
|
*/
|
||||||
bool optimizerMayEmit(const QString &code);
|
bool optimizerMayEmit(const QString &code);
|
||||||
|
|
||||||
}
|
}
|
||||||
@ -496,7 +501,7 @@ QString publishedLevel(const LoadAction &action);
|
|||||||
* Helper UNIQUE des journaux `[Arbitre]`, `[RelayRouter]` et `[EtmVariableLoadAdapter]` : trois
|
* Helper UNIQUE des journaux `[Arbitre]`, `[RelayRouter]` et `[EtmVariableLoadAdapter]` : trois
|
||||||
* rendus divergeraient. Une action à un seul niveau rend exactement \c renderFr() — le journal
|
* rendus divergeraient. Une action à un seul niveau rend exactement \c renderFr() — le journal
|
||||||
* ne change pas quand il n'y a rien à ventiler. À deux niveaux ou plus :
|
* ne change pas quand il n'y a rien à ventiler. À deux niveaux ou plus :
|
||||||
* « <motif publié> — ventilation : éco 500 W [ECO_FLOOR_GRID] + confort 500 W [LOCK_MIN_ON]
|
* « \<motif publié\> — ventilation : éco 500 W [ECO_FLOOR_GRID] + confort 500 W [LOCK_MIN_ON]
|
||||||
* = 1000 W ». Les codes, pas leurs phrases : la phrase du motif publié est déjà en tête, et une
|
* = 1000 W ». Les codes, pas leurs phrases : la phrase du motif publié est déjà en tête, et une
|
||||||
* ligne qui en rendrait trois deviendrait illisible.
|
* ligne qui en rendrait trois deviendrait illisible.
|
||||||
*
|
*
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user