OpenXRay/xray-16

Documentation

Aperta

#207 aperta il 25 mag 2018

Vedi su GitHubGuida contributor
 (4 commenti) (3 reazioni) (0 assegnatari)C++ (519 fork)auto 404
Code QualityDocumentationHelp wantedInfrastructure

Metriche repository

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

Descrizione

We should document all the engine's code.

I suggest to use Doxygen, which is widely used. Other alternatives, maybe?

Guida contributor

Direzione di ricerca
Ricerca la configurazione di Doxygen per progetti C++ e proponi una configurazione di generazione della documentazione per il codebase del motore.
Tech stack
cpp
Dominio
game devdocumentation
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
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80