Docs: Switch Driver to Doxygen comment style

Aperta
  • Qualcosa non va?
#46 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
48/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
c
Ambito
documentation

Direzione di ricerca

Inizia dalla directory driver/ e fai un inventario dei commenti che devono essere convertiti allo stile Doxygen. Verifica se sono necessari dei tag files per includere le librerie nel progetto principale; il lavoro è completato quando i commenti in driver usano lo stile Doxygen e la documentazione richiesta delle librerie è inclusa.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

documentation

Description
This subtask is intended to capture the effort required to switch the comment style for driver/ to Doxygen in the firmware.

We should consider the use of tag files for the libraries to include them in the main project.

Points of Contact
Driver Maintainer: @ETSells

Lingua principale
C
Stelle
2
Fork
0
Merge medio
6g 17h
PR unite (30g)
3

Preparare l'ambiente

  • Nessun Dockerfile né file Docker Compose
  • Ha un modello di pull request
  • Nessuna guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di SunDevilRocketry/driver

Tutte le issue di SunDevilRocketry/driver

Issue simili

Altre issue su C

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.