TarekSaeed0/chess

doc: add documentation to chess.h

Aperta

#2 aperta il 26 mag 2025

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)C (0 fork)auto 404
documentationgood first issue

Metriche repository

Star
 (0 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

adding Doxygen comments for the various types and functions in chess.h will help with new contributors and users of the library, understand the various types and functions defined and how to use them correctly, as currently the generated documentation is mostly empty.

Guida contributor

Direzione di ricerca
Apri chess.h e aggiungi commenti Doxygen per ogni tipo e funzione seguendo le convenzioni esistenti. Usa i tag `@param`, `@return`, `@brief`.
Tech stack
c
Dominio
backend
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
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.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
C
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90