Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

core(cmd) : Improve cmd class PHPDoc #3026

Open
wants to merge 1 commit into
base: alpha
Choose a base branch
from

Conversation

kwizer15
Copy link
Contributor

@kwizer15 kwizer15 commented Feb 6, 2025

Documentation PHPDoc de la classe cmd

Description

Cette PR standardise la documentation PHPDoc de la classe cmd (cmd.class.php).
Aucun changement fonctionnel n'est effectué.

Note : Les types documentés sont basés sur l'analyse statique du code. Il est possible que certains types soient incomplets ou imprécis, notamment pour les valeurs de retour complexes ou les tableaux associatifs. N'hésitez pas à signaler toute erreur ou imprécision dans les types documentés pour améliorer la qualité de la documentation. Les retours d'expérience sur l'utilisation réelle des méthodes sont particulièrement appréciés pour affiner la documentation.

Merci de créer de commenter directement cette PR si vous constatez des erreurs ou avez des suggestions d'amélioration.

Points clés

  • Documentation complète des classes et méthodes avec types stricts
  • Documentation précise des types de retour
  • Spécification des dépendances entre les composants via @see
  • Respect des standards de documentation Jeedom

Suggested changelog entry

  • Added standardized PHPDoc documentation for cmd class

Related issues/external references

https://github.com/jeedom/documentations/blob/89cf4578ad04b59abebe40217b6cfdf0dacc195e/fr_FR/dev/php/phpdoc.md
https://community.jeedom.com/t/aide-phpdoc-du-core/63287

Types of changes

  • Bug fix
  • New feature
  • Breaking change
  • Documentation improvement

PR checklist

  • I have checked there is no other PR open for the same change
  • I have read the contribution guidelines for this project
  • 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

@Mips2648 Mips2648 self-requested a review February 6, 2025 16:31
Copy link
Collaborator

@Mips2648 Mips2648 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

return type is incorrecte for most of the function, e.g.: return static[]

core/class/cmd.class.php Show resolved Hide resolved
@kwizer15 kwizer15 requested a review from Mips2648 February 7, 2025 08:19
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