RT-Thread/rt-thread

[Feature] [doc] doxygen文档中缺少driver相关的doxygen

Open

#9 424 ouverte le 11 sept. 2024

Voir sur GitHub
 (3 commentaires) (0 réactions) (1 assigné)C (4 755 forks)batch import
good first issue

Métriques du dépôt

Stars
 (9 223 stars)
Métriques de merge PR
 (Merge moyen 7j 22h) (50 PRs mergées en 30 j)

Description

Describe problem solved by the proposed feature

https://github.com/RT-Thread/rt-thread/tree/master/components/drivers/include/drivers

目前driver相关的doxygen中缺少一些注释，希望能添加doxygen注释和对应的example，方便后续开发和维护

Describe your preferred solution

参考doxygen链接 https://supperthomas.github.io/RTT_doxygen_API/

Describe possible alternatives

No response

Guide contributeur

Direction de recherche
Concentrez vous sur les en têtes de pilotes situés dans components/drivers/include/drivers. Choisissez un fichier de pilote (par exemple, drivers/include/drivers/rt device.h) et ajoutez des commentaires Doxygen pour les fonctions et structures de données existantes. Utilisez l'exemple sur https://supperthomas.github.io/RTT doxygen API/ comme référence de style. Assurez vous d'inclure un bref exemple d'utilisation dans les commentaires de documentation. Après avoir terminé un pilote, soumettez une pull request et itérez en fonction des retours.
Stack technique
c
Domaine
backenddocumentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
CDoxygen
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75