TarekSaeed0/chess

doc: add documentation to chess.h

Aberta

#2 aberto em 26 de mai. de 2025

Ver no GitHub
 (0 comentário) (0 reação) (0 responsável)C (0 fork)auto 404
documentationgood first issue

Métricas do repositório

Stars
 (0 estrela)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

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.

Guia do colaborador

Direção de pesquisa
Abra chess.h e adicione comentários Doxygen para cada tipo e função seguindo as convenções existentes. Use tags `@param`, `@return`, `@brief`.
Pilha de tecnologia
c
Domain
backend
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.
1
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.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
C
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90