Docs: Switch Driver to Doxygen comment style

Abierto
  • ¿Algo no está bien?
#46 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
48/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Tranquilo
Stack tecnológico
c
Área
documentation

Línea de trabajo

Comienza con el directorio driver/ y haz un inventario de los comentarios que deben convertirse al estilo Doxygen. Investiga si se necesitan tag files para incluir las bibliotecas en el proyecto principal; se considera terminado cuando los comentarios de driver usan el estilo Doxygen y se incluye la documentación necesaria de las bibliotecas.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

documentation

Description
This subtask is intended to capture the effort required to switch the comment style for driver/ to Doxygen in the firmware.

We should consider the use of tag files for the libraries to include them in the main project.

Points of Contact
Driver Maintainer: @ETSells

Lenguaje dominante
C
Estrellas
2
Forks
0
Merge medio
6 d 17 h
PR fusionados (30 d)
3

Preparar el entorno

  • Sin Dockerfile ni archivo de Docker Compose
  • Tiene una plantilla de pull request
  • Sin guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de SunDevilRocketry/driver

Todos los issues de SunDevilRocketry/driver

Issues similares

Más issues de C

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.