Skip to content

Documentation: Amélioration de la PHPDoc de la classe ajax selon les nouveaux standards#3011

Merged
Sekiro-kost merged 1 commit into
jeedom:alphafrom
kwizer15:feat/doc-ajax
May 15, 2025
Merged

Documentation: Amélioration de la PHPDoc de la classe ajax selon les nouveaux standards#3011
Sekiro-kost merged 1 commit into
jeedom:alphafrom
kwizer15:feat/doc-ajax

Conversation

@kwizer15

@kwizer15 kwizer15 commented Jan 12, 2025

Copy link
Copy Markdown
Contributor

Description

Cette PR propose une amélioration de la documentation PHPDoc de la classe ajax.class.php pour la rendre conforme aux nouveaux standards de documentation établis pour le core.

Les principaux changements incluent :

  • Passage de la documentation en anglais
  • Simplification des descriptions pour une meilleure lisibilité
  • Suppression des TODOs et des notes d'évolution
  • Ajout des tags manquants (@deprecated, @return)
  • Amélioration des références croisées (@see)
  • Documentation plus précise des paramètres et types de retour

Cette mise à jour s'inscrit dans une démarche globale d'amélioration de la documentation du core.

Post community : https://community.jeedom.com/t/aide-phpdoc-du-core/63287/12
Standards de la phpdoc en cours de rédaction : https://github.com/kwizer15/jeedom-documentations/blob/feat/doc-phpdoc/fr_FR/dev/php/phpdoc.md

Suggested changelog entry

Amélioration de la PHPDoc de la classe ajax selon les nouveaux standards de documentation du core.

Related issues/external references

Lié à #3004 #3010

Types of changes

  • Bug fix
  • New feature
  • Breaking change
    • This change is only breaking for integrators, not for external standards or end-users.
  • Documentation improvement

PR checklist

  • I have checked there is no other PR open for the same change.
  • I have read the contribution guidelines.
  • I grant the project the right to include and distribute the code under the GNU.
  • I have added tests to cover my changes.
  • I have verified that the code complies with the projects coding standards.
  • [Required for new sniffs] I have added MD documentation for the sniff.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants