RT-Thread/rt-thread

[Feature] [doc] doxygen文档中缺少driver相关的doxygen

Open

#9.424 aberto em 11 de set. de 2024

Ver no GitHub
 (3 comments) (0 reactions) (1 assignee)C (4.755 forks)batch import
good first issue

Métricas do repositório

Stars
 (9.223 stars)
Métricas de merge de PR
 (Mesclagem média 7d 22h) (50 fundiu PRs em 30d)

Description

Describe problem solved by the proposed feature

https://github.com/RT-Thread/rt-thread/tree/master/components/drivers/include/drivers

目前driver相关的doxygen中缺少一些注释，希望能添加doxygen注释和对应的example，方便后续开发和维护

Describe your preferred solution

参考doxygen链接 https://supperthomas.github.io/RTT_doxygen_API/

Describe possible alternatives

No response

Guia do colaborador

Direção de pesquisa
Foque nos cabeçalhos de driver localizados em components/drivers/include/drivers. Escolha um arquivo de driver (por exemplo, drivers/include/drivers/rt device.h) e adicione comentários Doxygen para as funções e estruturas de dados existentes. Use o exemplo em https://supperthomas.github.io/RTT doxygen API/ como referência de estilo. Certifique se de incluir um breve exemplo de uso nos comentários da documentação. Após concluir um driver, envie um pull request e itere com base no feedback.
Pilha de tecnologia
c
Domain
backenddocumentation
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
CDoxygen
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75