Correction et amélioration de PHPdoc (array précisé, uses)

action/cloturer_observation.php

@@ -15,11 +15,13 @@ if (!defined('_ECRIRE_INC_VERSION')) {
  * Elle nécessite l'action proprement dite, à savoir, acquitter, corriger ou supprimer, l'id de l'observation et
  * celui de l'auteur.
  *
+ * @uses observation_cloturer()
+ *
  * @param null|string $arguments Arguments de l'action ou null si l'action est appelée par une URL
  *
  * @return void
  */
-function action_cloturer_observation_dist(?string $arguments = null): void {
+function action_cloturer_observation_dist(?string $arguments = null) : void {
 	// Sécurisation.
 	// Arguments attendus :
 	// - le nom de l'action corriger ou acquitter

action/executer_type_controle.php

@@ -11,6 +11,8 @@ if (!defined('_ECRIRE_INC_VERSION')) {
  * Cette action permet à l'utilisateur d'exécuter, de façon sécurisée,
  * les vérifications inhérentes au type de contrôle.
  *
+ * @uses type_controle_executer()
+ *
  * Cette action est réservée aux utilisateurs pouvant exécuter un contrôle.
  * Elle nécessite le type de contrôle et l'id de l'auteur comme arguments.
  * Quand elle est appelée via un formulaire de choix de paramètres additionnels à fournir à la fonction de contrôle
@@ -20,7 +22,7 @@ if (!defined('_ECRIRE_INC_VERSION')) {
  *
  * @return void
  */
-function action_executer_type_controle_dist(?string $arguments = null): void {
+function action_executer_type_controle_dist(?string $arguments = null) : void {
 	// Sécurisation.
 	// Arguments attendus :
 	// - l'identifiant du type de contrôle

action/inverser_activite_type_controle.php

@@ -18,7 +18,7 @@ if (!defined('_ECRIRE_INC_VERSION')) {
  *
  * @return void
  */
-function action_inverser_activite_type_controle_dist(?string $arguments = null): void {
+function action_inverser_activite_type_controle_dist(?string $arguments = null) : void {
 	// Sécurisation.
 	// Arguments attendus :
 	// - l'identifiant du type de contrôle

action/recharger_dashboards.php

@@ -14,9 +14,11 @@ if (!defined('_ECRIRE_INC_VERSION')) {
  * Cette action est réservée aux utilisateurs pouvant utiliser le plugin Check Factory.
  * Elle ne nécessite aucun argument.
  *
+ * @uses dashboard_charger()
+ *
  * @return void
  */
-function action_recharger_dashboards_dist(): void {
+function action_recharger_dashboards_dist() : void {
 	// Verification des autorisations : pour recharger les types de contrôle il suffit
 	// d'avoir l'autorisation minimale d'accéder au contrôles de contrib.
 	if (!autoriser('ezcheck')) {

action/recharger_types_controle.php

@@ -14,9 +14,11 @@ if (!defined('_ECRIRE_INC_VERSION')) {
  * Cette action est réservée aux utilisateurs pouvant utiliser le plugin Check Factory.
  * Elle ne nécessite aucun argument.
  *
+ * @uses type_controle_charger()
+ *
  * @return void
  */
-function action_recharger_types_controle_dist(): void {
+function action_recharger_types_controle_dist() : void {
 	// Verification des autorisations : pour recharger les types de contrôle il suffit
 	// d'avoir l'autorisation minimale de Check Factory.
 	if (!autoriser('ezcheck')) {

action/supprimer_observations.php

@@ -14,11 +14,14 @@ if (!defined('_ECRIRE_INC_VERSION')) {
  * Cette action est réservée aux utilisateurs pouvant vider les observations d'un type de contrôle.
  * Elle nécessite l'identifiant du type de contrôle, l'indicateur d'anomalie (oui/non) et l'id de l'auteur.
  *
+ * @uses observation_repertorier()
+ * @uses observation_cloturer()
+ *
  * @param null|string $arguments Arguments de l'action ou null si l'action est appelée par une URL
  *
  * @return void
  */
-function action_supprimer_observations_dist(?string $arguments = null): void {
+function action_supprimer_observations_dist(?string $arguments = null) : void {
 	// Sécurisation.
 	// Arguments attendus :
 	// - l'identifiant du type de contrôle

base/ezcheck_declarations.php

@@ -18,7 +18,7 @@ if (!defined('_ECRIRE_INC_VERSION')) {
  *
  * @return array Tableau fourni en entrée et mis à jour avec les nouvelles déclarations
  */
-function ezcheck_declarer_tables_principales(array $tables_principales): array {
+function ezcheck_declarer_tables_principales(array $tables_principales) : array {
 	// Table spip_types_noisettes
 	$types_controles = [
 		'identifiant' => "varchar(255) DEFAULT '' NOT NULL",  // Identifiant du type de contrôle
@@ -64,7 +64,7 @@ function ezcheck_declarer_tables_principales(array $tables_principales): array {
  *
  * @return array Description des tables de la base complétée par celles du plugin.
  */
-function ezcheck_declarer_tables_objets_sql(array $tables_objet_sql): array {
+function ezcheck_declarer_tables_objets_sql(array $tables_objet_sql) : array {
 	// Table spip_controles, description des contrôles manuels ou périodiques, instances d'un type de contrôle.
 	$tables_objet_sql['spip_controles'] = [
 		'type'       => 'controle',
@@ -206,7 +206,7 @@ function ezcheck_declarer_tables_objets_sql(array $tables_objet_sql): array {
  *
  * @return array Tableau fourni en entrée et mis à jour avec les nouvelles informations
  */
-function ezcheck_declarer_tables_interfaces(array $interface): array {
+function ezcheck_declarer_tables_interfaces(array $interface) : array {
 	// Les tables : permet d'appeler une boucle avec le *type* de la table uniquement
 	$interface['table_des_tables']['types_controles'] = 'types_controles';
 	$interface['table_des_tables']['controles'] = 'controles';

ezcache/ezcheck.php

@@ -11,9 +11,9 @@ if (!defined('_ECRIRE_INC_VERSION')) {
  *
  * @param string $plugin Préfixe du plugin, à savoir, `ezcheck`.
  *
- * @return array Tableau de la configuration brute du plugin Check Factory.
+ * @return array<string, mixed> Tableau de la configuration brute du plugin Check Factory.
  */
-function ezcheck_cache_configurer(string $plugin): array {
+function ezcheck_cache_configurer(string $plugin) : array {
 	// Initialisation du tableau de configuration avec les valeurs par défaut du plugin Check Factory.
 	$configuration = [
 		'dashboard' => [

ezcheck_administrations.php

@@ -13,14 +13,12 @@ if (!defined('_ECRIRE_INC_VERSION')) {
  *
  * Le schéma comprend des tables et des variables de configuration.
  *
- * @api
- *
  * @param string $nom_meta_base_version Nom de la meta dans laquelle sera rangée la version du schéma
  * @param string $version_cible         Version du schéma de données en fin d'upgrade
  *
  * @return void
  */
-function ezcheck_upgrade(string $nom_meta_base_version, string $version_cible): void {
+function ezcheck_upgrade(string $nom_meta_base_version, string $version_cible) : void {
 	$maj = [];
 
 	// Création des tables
@@ -51,13 +49,11 @@ function ezcheck_upgrade(string $nom_meta_base_version, string $version_cible):
  * Suppression de l'ensemble du schéma de données propre au plugin, c'est-à-dire
  * les tables et les variables de configuration.
  *
- * @api
- *
  * @param string $nom_meta_base_version Nom de la meta dans laquelle sera rangée la version du schéma
  *
  * @return void
  */
-function ezcheck_vider_tables(string $nom_meta_base_version): void {
+function ezcheck_vider_tables(string $nom_meta_base_version) : void {
 	// On efface les tables des contrôles et anomalies
 	sql_drop_table('spip_types_controles');
 	sql_drop_table('spip_controles');

ezcheck_fonctions.php

@@ -22,7 +22,7 @@ if (!defined('_ECRIRE_INC_VERSION')) {
  *
  * @return Champ Pile complétée par le code à générer.
  **/
-function balise_DASHBOARD_dist(Champ $p): Champ {
+function balise_DASHBOARD_dist(Champ $p) : Champ {
 	// Récupération des arguments de la balise.
 	// -- Identifiant du dashboard uniquement.
 	$dashboard_id = interprete_argument_balise(1, $p);
@@ -45,11 +45,7 @@ function balise_DASHBOARD_dist(Champ $p): Champ {
  *
  * @balise
  *
- * @param Champ $p Pile au niveau de la balise.
- *
- * @return Champ Pile complétée par le code à générer.
- *
- **@example
+ * @example
  *     ```
  *     #DASHBOARD_CONTEXTE{contrib, '', ''}, renvoie la description complète du dashboard d'id `contrib` ainsi que
  *     l'id du premier groupe et le premier type de contrôle listé dans le groupe.
@@ -58,8 +54,12 @@ function balise_DASHBOARD_dist(Champ $p): Champ {
  *     #DASHBOARD_CONTEXTE{contrib, 'article', 'article_prepa'}, renvoie la description complète du dashboard d'id `contrib` ainsi que
  *     l'id du groupe et du type de contrôle précisés.
  *     ```
+ *
+ * @param Champ $p Pile au niveau de la balise.
+ *
+ * @return Champ Pile complétée par le code à générer.
  */
-function balise_DASHBOARD_CONTEXTE_dist(Champ $p): Champ {
+function balise_DASHBOARD_CONTEXTE_dist(Champ $p) : Champ {
 	// Récupération des arguments de la balise.
 	// -- Tous les arguments sont obligatoires.
 	$dashboard_id = interprete_argument_balise(1, $p);
@@ -88,7 +88,7 @@ function balise_DASHBOARD_CONTEXTE_dist(Champ $p): Champ {
  *
  * @return Champ Pile complétée par le code à générer.
  */
-function balise_TYPE_CONTROLE_DASHBOARD_dist(Champ $p): Champ {
+function balise_TYPE_CONTROLE_DASHBOARD_dist(Champ $p) : Champ {
 	// Récupération des arguments.
 	// -- l'identifiant du type de contrôle unoiquement
 	$type_controle = interprete_argument_balise(1, $p);
@@ -105,12 +105,12 @@ function balise_TYPE_CONTROLE_DASHBOARD_dist(Champ $p): Champ {
 /**
  * Construit le titre d'un contrôle.
  *
- * @param int   $id_objet Identifiant du contrôle
- * @param array $champs   Liste des champs de l'objet concerné
+ * @param int                  $id_objet Identifiant du contrôle
+ * @param array<string, mixed> $champs   Liste des champs de l'objet concerné
  *
  * @return string
  */
-function generer_titre_controle(int $id_objet, array $champs): string {
+function generer_titre_controle(int $id_objet, array $champs) : string {
 	// Le titre d'un contrôle est de la forme type_controle:id
 	$titre = "{$champs['type_controle']}:{$id_objet}";
 
@@ -120,12 +120,12 @@ function generer_titre_controle(int $id_objet, array $champs): string {
 /**
  * Construit le titre d'une observation.
  *
- * @param int   $id_objet Identifiant de l'observation
- * @param array $champs   Liste des champs de l'objet concerné
+ * @param int                  $id_objet Identifiant de l'observation
+ * @param array<string, mixed> $champs   Liste des champs de l'objet concerné
  *
  * @return string
  */
-function generer_titre_observation(int $id_objet, array $champs): string {
+function generer_titre_observation(int $id_objet, array $champs) : string {
 	// Le titre d'une observation est de la forme code:id
 	$titre = "{$champs['code']}:{$champs['id_controle']}-{$id_objet}";
 

ezcheck_pipelines.php

@@ -13,11 +13,14 @@ if (!defined('_ECRIRE_INC_VERSION')) {
  * - on recharge les types de contrôle.
  * - on recharge les dashboards
  *
+ * @uses type_controle_charger()
+ * @uses dashboard_charger()
+ *
  * @param array $flux Flux d'entrée contenant la chaine affichée
  *
  * @return array Flux complétée par Check Factory
  */
-function ezcheck_affiche_milieu(array $flux): array {
+function ezcheck_affiche_milieu(array $flux) : array {
 	if (isset($flux['args']['exec'])) {
 		// Initialisation de la page du privé
 		$exec = $flux['args']['exec'];

formulaires/parametrer_controle.php

@@ -10,18 +10,21 @@ if (!defined('_ECRIRE_INC_VERSION')) {
  * Chargement des données du formaulaire : le formulaire permet d'afficher le descriptif du type de contrôle et
  * d'éventuellement saisir des paramètres pour lancer la fonction de vérification.
  *
+ * @uses type_controle_lire()
+ * @uses observation_repertorier()
+ *
  * @param string      $type_controle Identifiant du type de contrôle
  * @param null|int    $id_auteur     Id de l'auteur ou 0 sinon
  * @param null|string $redirect      URL de la page à afficher suite à l'exécution du formulaire ou vide pour rester sur la même page
  *
- * @return array Tableau des données à charger par le formulaire (affichage et saisie) :
+ * @return <string, mixed> Tableau des données à charger par le formulaire (affichage et saisie) :
  *               - `_description`      : (affichage) descriptif du type de contrôle
  *               - `_message_inactif`  : (affichage) message éventuel expliquant l'inactivité du contrôle
  *               - `_champs_fonction`  : (saisie) liste des saisies pour les paramètres de la fonction de vérification
  *               - `_champs_squelette` : (saisie) liste des saisies pour les paramètres d'affichage du squelette complémentaire
  *               - `_bouton_execution` : (affichage) indique si le bouton d'exécution doit être affiché ou pas
  */
-function formulaires_parametrer_controle_charger_dist(string $type_controle, ?int $id_auteur = 0, ?string $redirect = ''): array {
+function formulaires_parametrer_controle_charger_dist(string $type_controle, ?int $id_auteur = 0, ?string $redirect = '') : array {
 	// Initialisation des valeurs à passer au formulaire
 	$valeurs = [
 		'editable'          => false,
@@ -74,13 +77,16 @@ function formulaires_parametrer_controle_charger_dist(string $type_controle, ?in
 /**
  * Vérification du formulaire : on lance les contrôles des saisies qui intègrent des vérifications.
  *
+ * @uses type_controle_lire()
+ * @uses saisies_verifier()
+ *
  * @param string      $type_controle Identifiant du type de contrôle
  * @param null|int    $id_auteur     Id de l'auteur ou 0 sinon
  * @param null|string $redirect      URL de la page à afficher suite à l'exécution du formulaire ou vide pour rester sur la même page
  *
- * @return array Tableau des erreurs indexé par les noms des champs en erreur
+ * @return <string, mixed> Tableau des erreurs indexé par les noms des champs en erreur
  */
-function formulaires_parametrer_controle_verifier_dist(string $type_controle, ?int $id_auteur = 0, ?string $redirect = ''): array {
+function formulaires_parametrer_controle_verifier_dist(string $type_controle, ?int $id_auteur = 0, ?string $redirect = '') : array {
 	$erreurs = [];
 
 	// Vérifier les champs correspondant aux paramètres spécifiques du type de contrôle
@@ -100,14 +106,18 @@ function formulaires_parametrer_controle_verifier_dist(string $type_controle, ?i
  * Exécution du formulaire : si le bouton d'exécution est affiché lancement de l'exécution de la vérification et affichage
  * des résultats.
  *
+ * @uses type_controle_lire()
+ * @uses saisies_lister_champs()
+ * @uses type_controle_executer()
+ *
  * @param string      $type_controle Identifiant du type de contrôle
  * @param null|int    $id_auteur     Id de l'auteur ou 0 sinon
  * @param null|string $redirect      URL de la page à afficher suite à l'exécution du formulaire ou vide pour rester sur la même page
  *
- * @return array Tableau de retour contenant soit le message d'erreur soit le message de bonne exécution et l'url de
- *               redirection éventuelle.
+ * @return array<string, mixed> Tableau de retour contenant soit le message d'erreur soit le message de bonne exécution et l'url de
+ *                              redirection éventuelle.
  */
-function formulaires_parametrer_controle_traiter_dist(string $type_controle, ?int $id_auteur = 0, ?string $redirect = ''): array {
+function formulaires_parametrer_controle_traiter_dist(string $type_controle, ?int $id_auteur = 0, ?string $redirect = '') : array {
 	$retour = [];
 
 	if (autoriser('executer', 'typecontrole', $type_controle)) {

inc/ezcheck_dashboard.php

@@ -14,9 +14,12 @@ if (!defined('_ECRIRE_INC_VERSION')) {
  *
  * @api
  *
+ * @uses yaml_decode_file()
+ * @uses cache_ecrire()
+ *
  * @return bool `false` si une erreur s'est produite, `true` sinon.
  */
-function dashboard_charger(): bool {
+function dashboard_charger() : bool {
 	// Retour de la fonction
 	$retour = true;
 
@@ -120,13 +123,15 @@ function dashboard_charger(): bool {
  *
  * @api
  *
+ * @uses dashboard_repertorier()
+ *
  * @param string    $id_dashboard Identifiant du dashboard.
  * @param null|bool $traiter_typo Indique si les données textuelles doivent être retournées brutes ou si elles doivent
  *                                être traitées en utilisant la fonction typo.
  *
- * @return array La description complète. Si demandé, les champs textuels peuvent être traités avec la fonction typo().
+ * @return array<string, mixed> La description complète. Si demandé, les champs textuels peuvent être traités avec la fonction typo().
  */
-function dashboard_lire(string $id_dashboard, ?bool $traiter_typo = false): array {
+function dashboard_lire(string $id_dashboard, ?bool $traiter_typo = false) : array {
 	// On met en cache mémoire statique les dashboards déjà lus.
 	static $dashboards_charges = [];
 
@@ -173,14 +178,16 @@ function dashboard_lire(string $id_dashboard, ?bool $traiter_typo = false): arra
  *
  * @api
  *
+ * @uses cache_lire()
+ *
  * @param null|string $information Identifiant d'un champ de la description d'un dashboard.
  *                                 Si l'argument est vide, la fonction renvoie les descriptions complètes et si l'argument est
  *                                 un champ invalide la fonction renvoie un tableau vide.
  *
- * @return array Tableau de la forme `[dashboard] = information ou description complète`. Les champs textuels
- *               sont retournés en l'état, le timestamp `maj` n'est pas fourni.
+ * @return array<string, mixed> Tableau de la forme `[dashboard] = information ou description complète`. Les champs textuels
+ *                              sont retournés en l'état, le timestamp `maj` n'est pas fourni.
  */
-function dashboard_repertorier(?string $information = ''): array {
+function dashboard_repertorier(?string $information = '') : array {
 	// Initialiser le tableau de sortie en cas d'erreur
 	$dashboards = [];
 
@@ -209,13 +216,17 @@ function dashboard_repertorier(?string $information = ''): array {
  * Renvoie la configuration complète d’un dashboard ainsi que des informations supplémentaires provenant
  * de l'environnement de la page dashboard (groupe et type de contrôle à afficher par défaut).
  *
+ * @api
+ *
+ * @uses dashboard_lire()
+ *
  * @param string      $id_dashboard  Identifiant du dashboard
  * @param null|string $id_groupe     Identifiant du groupe affiché par défaut ou vide pour afficher le premier
  * @param null|string $type_controle Identifiant du type de contrôle affiché par défaut ou vide pour afficher le premier
  *
- * @return array
+ * @return array<string, mixed> Tableau du contexte contenant la description du dashboard
  */
-function dashboard_contextualiser(string $id_dashboard, ?string $id_groupe = '', ?string $type_controle = ''): array {
+function dashboard_contextualiser(string $id_dashboard, ?string $id_groupe = '', ?string $type_controle = '') : array {
 	// On initialise le contexte à vide en cas d'erreur
 	$contexte = [];
 

inc/ezcheck_observation.php

@@ -9,13 +9,19 @@ if (!defined('_ECRIRE_INC_VERSION')) {
 /**
  * Ajoute une observation à la table `spip_observations`.
  *
+ * @api
+ *
+ * @uses objet_lire()
+ * @uses objet_inserer()
+ * @uses objet_modifier()
+ *
  * @param bool       $est_anomalie Indique si l'observation est une anomalie ou pas
  * @param int        $id_controle  Identifiant numérique du contrôle
  * @param null|array $valeurs      Tableau des valeurs de certains champs de l'observation
  *
  * @return int Identifiant numérique de l'observation crée ou 0 si erreur.
  */
-function observation_ajouter(bool $est_anomalie, int $id_controle, ?array $valeurs = []): int {
+function observation_ajouter(bool $est_anomalie, int $id_controle, ?array $valeurs = []) : int {
 	// Lecture pour le contrôle concerné de son type et du nombre d'anomalies ouvertes.
 	// - on utilise le forcage de lecture pour by-passer le cache statique de la fonction objet_lire() car sinon
 	//   le nombre d'anomalies mis à jour lors de l'ajout de l'observation ne serait pas à jour.
@@ -69,16 +75,18 @@ function observation_ajouter(bool $est_anomalie, int $id_controle, ?array $valeu
  * n'est explicitement demandé.
  * Il est possible de filtrer la liste des observations.
  *
- * @param null|array  $filtres Tableau associatif `[champ] = valeur` ou `[champ] = !valeur` de critères de filtres sur les
- *                             champs chaine des types de contrôle. Les opérateurs égalité et inégalité sont possibles.
- * @param null|string $champ   Identifiant d'un champ de la description d'un contrôle.
- *                             Si l'argument est vide, la fonction renvoie les descriptions complètes et si l'argument est
- *                             un champ invalide la fonction renvoie un tableau vide.
+ * @api
+ *
+ * @param null|array<string, mixed> $filtres Tableau associatif `[champ] = valeur` ou `[champ] = !valeur` de critères de filtres sur les
+ *                                           champs chaine des types de contrôle. Les opérateurs égalité et inégalité sont possibles.
+ * @param null|string               $champ   Identifiant d'un champ de la description d'un contrôle.
+ *                                           Si l'argument est vide, la fonction renvoie les descriptions complètes et si l'argument est
+ *                                           un champ invalide la fonction renvoie un tableau vide.
  *
  * @return array Tableau de la forme `[id_observation] = champ ou description complète`. Les champs textuels
  *               et les tableaux sérialisés sont retournés en l'état.
  */
-function observation_repertorier(?array $filtres = [], ?string $champ = ''): array {
+function observation_repertorier(?array $filtres = [], ?string $champ = '') : array {
 	// On calcule le where à partir des filtres sachant que tous les champs sont des chaines.
 	$where = [];
 	if ($filtres) {
@@ -115,6 +123,12 @@ function observation_repertorier(?array $filtres = [], ?string $champ = ''): arr
  * Acquitter et supprimer sont des actions qui ne requièrent que la mise à jour du statut. L'action correction elle
  * nécessite l'appel à la fonction de correction configurée.
  *
+ * @api
+ *
+ * @uses objet_lire()
+ * @uses type_controle_lire()
+ * @uses objet_modifier()
+ *
  * @param string $action         Identifiant de l'action à appliquer à l'observation. Prend les valeurs `corriger`,
  *                               `acquitter` ou `supprimer`.
  * @param int    $id_observation Identifiant numérique de l'observation.
@@ -122,7 +136,7 @@ function observation_repertorier(?array $filtres = [], ?string $champ = ''): arr
  *
  * @return bool
  */
-function observation_cloturer($action, $id_observation, $id_auteur) {
+function observation_cloturer(string $action, int $id_observation, int $id_auteur) : bool {
 	// Initialisation du retour de la fonction
 	$retour = true;
 

inc/ezcheck_type_controle.php

@@ -14,12 +14,14 @@ if (!defined('_ECRIRE_INC_VERSION')) {
  *
  * @api
  *
+ * @uses type_controle_repertorier()
+ *
  * @param null|bool $recharger Si `true` force le rechargement de tous les types de contrôles sinon le chargement se base
  *                             sur le md5 des fichiers YAML. Par défaut vaut `false`.
  *
  * @return bool `false` si une erreur s'est produite, `true` sinon.
  */
-function type_controle_charger(?bool $recharger = false): bool {
+function type_controle_charger(?bool $recharger = false) : bool {
 	// Retour de la fonction
 	$retour = true;
 
@@ -351,16 +353,18 @@ function type_controle_lire(string $id_type_controle, ?array $champs = []) {
  * Renvoie l'information brute demandée pour l'ensemble des contrôles utilisés
  * ou toutes les descriptions si aucune information n'est explicitement demandée.
  *
- * @param null|array  $filtres Tableau associatif `[champ] = valeur` ou `[champ] = !valeur` de critères de filtres sur les
- *                             champs chaine des types de contrôle. Les opérateurs égalité et inégalité sont possibles.
- * @param null|string $champ   Identifiant d'un champ de la description d'un contrôle.
- *                             Si l'argument est vide, la fonction renvoie les descriptions complètes et si l'argument est
- *                             un champ invalide la fonction renvoie un tableau vide.
+ * @api
+ *
+ * @param null|array<string, mixed> $filtres Tableau associatif `[champ] = valeur` ou `[champ] = !valeur` de critères de filtres sur les
+ *                                           champs chaine des types de contrôle. Les opérateurs égalité et inégalité sont possibles.
+ * @param null|string               $champ   Identifiant d'un champ de la description d'un contrôle.
+ *                                           Si l'argument est vide, la fonction renvoie les descriptions complètes et si l'argument est
+ *                                           un champ invalide la fonction renvoie un tableau vide.
  *
- * @return array Tableau de la forme `[identifiant] = champ ou description complète`. Les champs textuels
- *               et les tableaux sérialisés sont retournés en l'état.
+ * @return array<string, mixed> Tableau de la forme `[identifiant] = champ ou description complète`. Les champs textuels
+ *                              et les tableaux sérialisés sont retournés en l'état.
  */
-function type_controle_repertorier(?array $filtres = [], ?string $champ = ''): array {
+function type_controle_repertorier(?array $filtres = [], ?string $champ = '') : array {
 	// On calcule le where à partir des filtres sachant que tous les champs sont des chaines.
 	$where = [];
 	if ($filtres) {
@@ -397,15 +401,21 @@ function type_controle_repertorier(?array $filtres = [], ?string $champ = ''): a
  * servant uniquement à l'affichage d'un squelette (ce n'est pas un état). Dans ce cas l'exécution ne fait que créer
  * un contrôle en pass thru.
  *
- * @param string $id_type_controle Id tu type de contrôle
- * @param int    $id_auteur        Id de l'auteur ayant lancé le contrôle (ou 0 pour le CRON)
- * @param array  $options          Tableau des arguments valorisés de la fonction et/ou du squelette. Peut être vide, sinon
- *                                 possède deux index `fonction` et `squelette`. Seul l'index `fonction` est fourni à la
- *                                 fonction d'exécution si elle existe mais les deux index sont stockés dans le contrôle.
+ * @api
+ *
+ * @uses objet_lire()
+ * @uses type_controle_lire()
+ * @uses objet_modifier()
+ *
+ * @param string               $id_type_controle Id tu type de contrôle
+ * @param int                  $id_auteur        Id de l'auteur ayant lancé le contrôle (ou 0 pour le CRON)
+ * @param array<string, mixed> $options          Tableau des arguments valorisés de la fonction et/ou du squelette. Peut être vide, sinon
+ *                                               possède deux index `fonction` et `squelette`. Seul l'index `fonction` est fourni à la
+ *                                               fonction d'exécution si elle existe mais les deux index sont stockés dans le contrôle.
  *
- * @return bool
+ * @return bool `false` si une erreur s'est produite, `true` sinon.
  */
-function type_controle_executer(string $id_type_controle, int $id_auteur, array $options): bool {
+function type_controle_executer(string $id_type_controle, int $id_auteur, array $options) : bool {
 	// On initialise le retour de la fonction à erreur
 	$retour = false;
 
@@ -486,11 +496,13 @@ function type_controle_executer(string $id_type_controle, int $id_auteur, array
  *
  * @api
  *
+ * @uses dashboard_repertorier()
+ *
  * @param string $id_type_controle Identifiant du type de contrôle.
  *
  * @return string Idenfiant du dashboard de rattachement ou chaine vide sinon.
  */
-function type_controle_identifier_dashboard(string $id_type_controle): string {
+function type_controle_identifier_dashboard(string $id_type_controle) : string {
 	// On renvoie chaine vide si pas trouvé
 	$id_dashboard = '';