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.

Sign up for GitHub

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

Jump to bottom

core(cron) : Improve cron class PHPDoc #3028

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

core(cron) : Improve cron class PHPDoc #3028

wants to merge 1 commit into from

Conversation

kwizer15
Copy link
Contributor

@kwizer15 kwizer15 commented Feb 7, 2025

Documentation PHPDoc de la classe cron

Description

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

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 cron 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 8, 2025 10:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Mips2648 Mips2648 Mips2648 approved these changes

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

Successfully merging this pull request may close these issues.
2 participants
@kwizer15 @Mips2648