RT-Thread/rt-thread

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

Open

#9424 aperta il 11 set 2024

Vedi su GitHub
 (3 commenti) (0 reazioni) (1 assegnatario)C (4755 fork)batch import
good first issue

Metriche repository

Star
 (9223 star)
Metriche merge PR
 (Merge medio 7g 22h) (50 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Concentrati sugli header dei driver situati in components/drivers/include/drivers. Scegli un file driver (ad esempio, drivers/include/drivers/rt device.h) e aggiungi commenti Doxygen per le funzioni e le strutture dati esistenti. Utilizza l'esempio su https://supperthomas.github.io/RTT doxygen API/ come riferimento per lo stile. Assicurati di includere un breve esempio di utilizzo nei commenti della documentazione. Dopo aver completato un driver, invia una pull request e itera in base al feedback ricevuto.
Tech stack
c
Dominio
backenddocumentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
CDoxygen
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75