Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

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

Open
kwizer15 wants to merge1 commit intojeedom:alpha
base:alpha
Choose a base branch
Loading
fromkwizer15:feat/doc-ajax

Conversation

kwizer15
Copy link
Contributor

@kwizer15kwizer15 commentedJan 12, 2025
edited
Loading

Description

Cette PR propose une amélioration de la documentation PHPDoc de la classeajax.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 freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@zoic21zoic21zoic21 approved these changes

@HotfirenetHotfirenetHotfirenet approved these changes

@Mips2648Mips2648Mips2648 approved these changes

@Sekiro-kostSekiro-kostSekiro-kost approved these changes

@tmartinez69009tmartinez69009Awaiting requested review from tmartinez69009

@SalvialfSalvialfAwaiting requested review from Salvialf

@reineabsreineabsAwaiting requested review from reineabs

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

8 participants
@kwizer15@zoic21@Hotfirenet@Mips2648@Sekiro-kost@tmartinez69009@Salvialf@reineabs

[8]ページ先頭

©2009-2025 Movatter.jp