RT-Thread/rt-thread

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

Offen

#9.424 geöffnet am 11.09.2024

Auf GitHub ansehenContributor Guide
 (3 Kommentare) (0 Reaktionen) (1 zugewiesene Person)C (4.755 Forks)batch import
good first issue

Repository-Metriken

Stars
 (9.223 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 7T 22h) (50 gemergte PRs in 30 T)

Beschreibung

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

Contributor Guide

Research-Richtung
Konzentriere dich auf die Treiber Header in components/drivers/include/drivers. Wähle eine Treiberdatei (z.B. drivers/include/drivers/rt device.h) und füge Doxygen Kommentare für bestehende Funktionen und Datenstrukturen hinzu. Verwende das Beispiel unter https://supperthomas.github.io/RTT doxygen API/ als Stilreferenz. Stelle sicher, dass du in den Dokumentationskommentaren ein kurzes Nutzungsbeispiel einfügst. Nach Abschluss eines Treibers, reiche einen Pull Request ein und iteriere basierend auf dem Feedback.
Tech Stack
c
Domain
backenddocumentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
CDoxygen
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75