diff --git a/inc/alumnos.h b/inc/alumnos.h index 34f71b8..312575f 100644 --- a/inc/alumnos.h +++ b/inc/alumnos.h @@ -29,6 +29,9 @@ extern "C" { /*=====[Definitions of public data types]====================================*/ +/** + * @brief Estructura con los datos del alumno +*/ typedef struct alumno_s { char apellidos[30]; char nombres[30]; @@ -39,6 +42,13 @@ typedef struct alumno_s { /*=====[Prototypes (declarations) of public functions]=======================*/ + +/** + * @brief Función serializar alumno + * @param cadena + * @param espacio + * @return True o False + */ bool SerializarAlumno(char * cadena, size_t espacio, const alumno_t alumno); bool SerializarAlumnos(char * cadena, size_t espacio); diff --git a/makefile b/makefile index 6e5d9a6..0dcb350 100644 --- a/makefile +++ b/makefile @@ -29,3 +29,6 @@ $(BIN_DIR): $(OUT_DIR) $(OBJ_DIR): $(OUT_DIR) @echo Creating output objects folder @mkdir $(OBJ_DIR) + +doc: + doxygen $(INC_DIR)/*.h $(SRC_DIR)/*.c diff --git a/src/alumnos.c b/src/alumnos.c index dc3b4d9..95210d2 100644 --- a/src/alumnos.c +++ b/src/alumnos.c @@ -1,11 +1,9 @@ -/*=====[Module Name]=========================================================== - * Copyright 2019 Esteban Daniel VOLENTINI - * All rights reserved. - * License: BSD-3-Clause ) - * - * Version: 0.1.0 - * Creation Date: 2019/03/01 - */ +/** + * @file alumnos.c + * @brief Módulo que implementa las funciones... + * @author -------- + * @date 19/12/2020 +*/ /*=====[Inclusion of own header]=============================================*/ @@ -31,8 +29,16 @@ static const struct alumno_s ESTEBAN_VOLENTINI = { .documento = "23.517.968", }; + +static const struct alumno_s FERNANDO_TAJES = { + .apellidos = "TAJES", + .nombres = "Fernando", + .documento = "3.864.221-4", +}; + const alumno_t ALUMNOS[] = { &ESTEBAN_VOLENTINI, + &FERNANDO_TAJES, }; const int CANTIDAD_ALUMNOS = (sizeof(ALUMNOS) / sizeof(alumno_t)); @@ -45,6 +51,9 @@ const int CANTIDAD_ALUMNOS = (sizeof(ALUMNOS) / sizeof(alumno_t)); /*=====[Implementations of interrupt functions]==============================*/ +/** + * @brief Función que serializa al alumno +*/ bool SerializarAlumno(char * cadena, size_t espacio, const alumno_t alumno) { int resultado; const char FORMATO[] = "{" @@ -59,6 +68,9 @@ bool SerializarAlumno(char * cadena, size_t espacio, const alumno_t alumno) { return (resultado >= 0); } +/** + * @brief Función que serializa a los alumnos +*/ bool SerializarAlumnos(char * cadena, size_t espacio) { static const int cantidad = sizeof(ALUMNOS) / sizeof(alumno_t); int posicion = snprintf(cadena, espacio, "[\r\n ");