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

Add developer documentation for PHPDoc #157

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

kwizer15
Copy link

@kwizer15 kwizer15 commented Feb 3, 2025

Description

Création des standards de documentation PHP pour le Core Jeedom, basés sur les discussions https://community.jeedom.com/t/aide-phpdoc-du-core/63287 . Ces standards définissent les règles pour une documentation PHPDoc claire, concise et utile.

Les règles couvrent :

  • La langue à utiliser
  • La portée et le format de la documentation
  • Les standards pour les classes et méthodes
  • La documentation des types
  • Les éléments interdits
  • La gestion des exemples et références

Ajout d'une section dédiée à la documentation PHP :

  • Création de dev/php/index.md comme point d'entrée et sommaire (à valider)
  • Ajout d'un lien dans dev/index.md pour accéder à la section PHP

Je n'ai pas fait les traductions dans les autres langues. Je peux le faire au besoin.

Suggested changelog entry

Ajout des standards de documentation PHP et d'une section dédiée dans la documentation développeur.

Related issues/external references

jeedom/core#3011

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.

@Mips2648
Copy link
Contributor

Mips2648 commented Feb 3, 2025

  1. I suggest to add a link to this page in the index page: https://github.com/jeedom/documentations/blob/master/fr_FR/dev/index.md
  2. I see you create "php" subfolder; to be confirmed we should do that

for the rest, I think it is clear enough

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.

2 participants