OpenXRay/xray-16

Documentation

Aberta

#207 aberto em 25 de mai. de 2018

Ver no GitHubGuia do colaborador
 (4 comentários) (3 reações) (0 responsável)C++ (519 forks)auto 404
Code QualityDocumentationHelp wantedInfrastructure

Métricas do repositório

Stars
 (3.524 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

We should document all the engine's code.

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

Guia do colaborador

Direção de pesquisa
Pesquise a configuração do Doxygen para projetos C++ e proponha uma configuração de geração de documentação para a base de código do motor.
Pilha de tecnologia
cpp
Domain
game devdocumentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80