cese-ids · gaston-cb · Apr 2, 2022 · Apr 20, 2022 · Apr 20, 2022 · Apr 20, 2022
diff --git a/.gitignore b/.gitignore
@@ -1 +1,2 @@
-build
+build
+doc
diff --git a/Doxyfile b/Doxyfile
@@ -1,18 +1,18 @@
-PROJECT_NAME            = TP4IDS
-PROJECT_NUMBER          = 1.0
-DOXYFILE_ENCODING       = UTF-8
-OUTPUT_DIRECTORY        = doc
-OUTPUT_LANGUAGE         = Spanish
-INPUT 			        += ./scr
-INPUT 			        += ./inc
-RECURSIVE               = YES
-EXTRACT_ALL             = YES
-FILE_PATTERNS           = *.c *.h 
-SHOW_USED_FILES         = YES
-SHOW_FILES              = YES
-SHOW_NAMESPACES         = YES
-SOURCE_BROWSER          = YES
-GENERATE_HTML           = YES
-HTML_OUTPUT             = html
-GENERATE_LATEX          = NO
-HAVE_DOT		        = NO
+PROJECT_NAME            = TP4IDS
+PROJECT_NUMBER          = 1.0
+DOXYFILE_ENCODING       = UTF-8
+OUTPUT_DIRECTORY        = doc
+OUTPUT_LANGUAGE         = Spanish
+INPUT 			        += ./scr
+INPUT 			        += ./inc
+RECURSIVE               = YES
+EXTRACT_ALL             = YES
+FILE_PATTERNS           = *.c *.h 
+SHOW_USED_FILES         = YES
+SHOW_FILES              = YES
+SHOW_NAMESPACES         = YES
+SOURCE_BROWSER          = YES
+GENERATE_HTML           = YES
+HTML_OUTPUT             = html
+GENERATE_LATEX          = NO
+HAVE_DOT		        = NO
diff --git a/LICENSE b/LICENSE
@@ -1,29 +1,29 @@
-BSD 3-Clause License
-
-Copyright (c) 2020, Catedra de Ingenieria de Software CESE UBA
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice, this
-   list of conditions and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright notice,
-   this list of conditions and the following disclaimer in the documentation
-   and/or other materials provided with the distribution.
-
-3. Neither the name of the copyright holder nor the names of its
-   contributors may be used to endorse or promote products derived from
-   this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+BSD 3-Clause License
+
+Copyright (c) 2020, Catedra de Ingenieria de Software CESE UBA
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/README.md b/README.md
@@ -1,39 +1,39 @@
-# Trabajo Practico Numero 5
-
-Repositorio inicial para el Trabajo Practico 5 de la asignatura de Ingeniería de Software de la carrera de Especialización en Sistemas Embebidos
-
-## Segunda Parte
-
-1. Crear un repositorio personal realizando un *fork* del repositorio de la catedra, clonar el repositorio personal en su computadora y desplegar la rama *master*.
-
-2. Editar la definicion de la constante ALUMNOS siguiendo el siguiente ejemplo
-
-    ```c
-    static const struct alumno_s ESTEBAN_VOLENTINI = {
-        .apellidos = "VOLENTINI",
-        .nombres = "Esteban Daniel",
-        .documento = "23.517.968",
-    };
-
-    const alumno_t ALUMNOS[] = {
-        &ESTEBAN_VOLENTINI,
-    };
-    ```
-
-3. Compilar el programa, ejecutarlo y revisar que el mismo funcione correctamente.
-
-4. Confirmar los cambios, subirlos al servidor y pedir un *pull request* poniendo con el texto **"Se agregan los datos del alumno APELLIDO, Nombre"** en la descipción del mismo.
-
-5. Revisar que el pull request esté en condiciones de ser mezclado y corregir los conflictos si fuera necesario.
-
-## Tercera Parte
-
-1. Crear una rama *develop* en su repositorio personal y desplegarla.
-
-2. Documentar los archivos `alumnos.h` y `alumnos.c` siguiendo los criterios proporcionados en la clase practica.
-
-3. Modificar el archivo `makefile` para agregar una regla que genere la documentacion con el comando `make doc`
-
-4. Modificar la lista de archivos ignorados para omitir toda la documentacion generada por Doxygen
-
-5. Confirmar los cambios y subirlos al servidor.
+# Trabajo Practico Numero 5
+
+Repositorio inicial para el Trabajo Practico 5 de la asignatura de Ingeniería de Software de la carrera de Especialización en Sistemas Embebidos
+
+## Segunda Parte
+
+1. Crear un repositorio personal realizando un *fork* del repositorio de la catedra, clonar el repositorio personal en su computadora y desplegar la rama *master*.
+
+2. Editar la definicion de la constante ALUMNOS siguiendo el siguiente ejemplo
+
+    ```c
+    static const struct alumno_s ESTEBAN_VOLENTINI = {
+        .apellidos = "VOLENTINI",
+        .nombres = "Esteban Daniel",
+        .documento = "23.517.968",
+    };
+
+    const alumno_t ALUMNOS[] = {
+        &ESTEBAN_VOLENTINI,
+    };
+    ```
+
+3. Compilar el programa, ejecutarlo y revisar que el mismo funcione correctamente.
+
+4. Confirmar los cambios, subirlos al servidor y pedir un *pull request* poniendo con el texto **"Se agregan los datos del alumno APELLIDO, Nombre"** en la descipción del mismo.
+
+5. Revisar que el pull request esté en condiciones de ser mezclado y corregir los conflictos si fuera necesario.
+
+## Tercera Parte
+
+1. Crear una rama *develop* en su repositorio personal y desplegarla.
+
+2. Documentar los archivos `alumnos.h` y `alumnos.c` siguiendo los criterios proporcionados en la clase practica.
+
+3. Modificar el archivo `makefile` para agregar una regla que genere la documentacion con el comando `make doc`
+
+4. Modificar la lista de archivos ignorados para omitir toda la documentacion generada por Doxygen
+
+5. Confirmar los cambios y subirlos al servidor.
diff --git a/doc/html/alumnos_8h.html b/doc/html/alumnos_8h.html
@@ -0,0 +1,211 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=9"/>
+<meta name="generator" content="Doxygen 1.8.13"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>TP4IDS: Referencia del Archivo inc/alumnos.h</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="jquery.js"></script>
+<script type="text/javascript" src="dynsections.js"></script>
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="search/searchdata.js"></script>
+<script type="text/javascript" src="search/search.js"></script>
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
+</head>
+<body>
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
+<div id="titlearea">
+<table cellspacing="0" cellpadding="0">
+ <tbody>
+ <tr style="height: 56px;">
+  <td id="projectalign" style="padding-left: 0.5em;">
+   <div id="projectname">TP4IDS
+   &#160;<span id="projectnumber">1.0</span>
+   </div>
+  </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generado por Doxygen 1.8.13 -->
+<script type="text/javascript">
+var searchBox = new SearchBox("searchBox", "search",false,'Buscar');
+</script>
+<script type="text/javascript" src="menudata.js"></script>
+<script type="text/javascript" src="menu.js"></script>
+<script type="text/javascript">
+$(function() {
+  initMenu('',true,false,'search.php','Buscar');
+  $(document).ready(function() { init_search(); });
+});
+</script>
+<div id="main-nav"></div>
+<!-- window showing the filter options -->
+<div id="MSearchSelectWindow"
+     onmouseover="return searchBox.OnSearchSelectShow()"
+     onmouseout="return searchBox.OnSearchSelectHide()"
+     onkeydown="return searchBox.OnSearchSelectKey(event)">
+</div>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<iframe src="javascript:void(0)" frameborder="0" 
+        name="MSearchResults" id="MSearchResults">
+</iframe>
+</div>
+
+<div id="nav-path" class="navpath">
+  <ul>
+<li class="navelem"><a class="el" href="dir_bfccd401955b95cf8c75461437045ac0.html">inc</a></li>  </ul>
+</div>
+</div><!-- top -->
+<div class="header">
+  <div class="summary">
+<a href="#nested-classes">Clases</a> &#124;
+<a href="#typedef-members">typedefs</a> &#124;
+<a href="#func-members">Funciones</a>  </div>
+  <div class="headertitle">
+<div class="title">Referencia del Archivo alumnos.h</div>  </div>
+</div><!--header-->
+<div class="contents">
+<div class="textblock"><code>#include &lt;stdbool.h&gt;</code><br />
+<code>#include &lt;stddef.h&gt;</code><br />
+</div>
+<p><a href="alumnos_8h_source.html">Ir al código fuente de este archivo.</a></p>
+<table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
+Clases</h2></td></tr>
+<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structalumno__s.html">alumno_s</a></td></tr>
+<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Estructura de datos para alumnos.  <a href="structalumno__s.html#details">Más...</a><br /></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table><table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
+typedefs</h2></td></tr>
+<tr class="memitem:a7ecf0f1c2bcbe176c4728702b992994e"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structalumno__s.html">alumno_s</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="alumnos_8h.html#a7ecf0f1c2bcbe176c4728702b992994e">alumno_t</a></td></tr>
+<tr class="memdesc:a7ecf0f1c2bcbe176c4728702b992994e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Estructura de datos para alumnos.  <a href="#a7ecf0f1c2bcbe176c4728702b992994e">Más...</a><br /></td></tr>
+<tr class="separator:a7ecf0f1c2bcbe176c4728702b992994e"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table><table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
+Funciones</h2></td></tr>
+<tr class="memitem:a94d19b92fc92e35f30662e321356326a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="alumnos_8h.html#a94d19b92fc92e35f30662e321356326a">SerializarAlumno</a> (char *cadena, size_t espacio, const <a class="el" href="alumnos_8h.html#a7ecf0f1c2bcbe176c4728702b992994e">alumno_t</a> alumno)</td></tr>
+<tr class="memdesc:a94d19b92fc92e35f30662e321356326a"><td class="mdescLeft">&#160;</td><td class="mdescRight">funcion de serialización de un alumno  <a href="#a94d19b92fc92e35f30662e321356326a">Más...</a><br /></td></tr>
+<tr class="separator:a94d19b92fc92e35f30662e321356326a"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:aef15ca72144639b5e2542aed76f8eb09"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="alumnos_8h.html#aef15ca72144639b5e2542aed76f8eb09">SerializarAlumnos</a> (char *cadena, size_t espacio)</td></tr>
+<tr class="separator:aef15ca72144639b5e2542aed76f8eb09"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table>
+<h2 class="groupheader">Documentación de los 'typedefs'</h2>
+<a id="a7ecf0f1c2bcbe176c4728702b992994e"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a7ecf0f1c2bcbe176c4728702b992994e">&#9670;&nbsp;</a></span>alumno_t</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">typedef struct <a class="el" href="structalumno__s.html">alumno_s</a>*  <a class="el" href="alumnos_8h.html#a7ecf0f1c2bcbe176c4728702b992994e">alumno_t</a></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Estructura de datos para alumnos. </p>
+
+</div>
+</div>
+<h2 class="groupheader">Documentación de las funciones</h2>
+<a id="a94d19b92fc92e35f30662e321356326a"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a94d19b92fc92e35f30662e321356326a">&#9670;&nbsp;</a></span>SerializarAlumno()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">bool SerializarAlumno </td>
+          <td>(</td>
+          <td class="paramtype">char *&#160;</td>
+          <td class="paramname"><em>cadena</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">size_t&#160;</td>
+          <td class="paramname"><em>espacio</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const <a class="el" href="alumnos_8h.html#a7ecf0f1c2bcbe176c4728702b992994e">alumno_t</a>&#160;</td>
+          <td class="paramname"><em>alumno</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>funcion de serialización de un alumno </p>
+<p>Esta funcion es utilizada para convertir una estructura de datos del tipo alumno a cadena y realizar la serialización</p>
+<dl class="params"><dt>Parámetros</dt><dd>
+  <table class="params">
+    <tr><td class="paramdir">[out]</td><td class="paramname">cadena</td><td>puntero a cadena con el resultado </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">espacio</td><td>tamaño del espacio </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">alumno</td><td>puntero a estructura de dato de tipo alumno </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Devuelve</dt><dd>true los datos del alumno se serializan correctamente </dd>
+<dd>
+false no hay espacio suficiente para serializar los datos del alumno </dd></dl>
+
+</div>
+</div>
+<a id="aef15ca72144639b5e2542aed76f8eb09"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aef15ca72144639b5e2542aed76f8eb09">&#9670;&nbsp;</a></span>SerializarAlumnos()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">bool SerializarAlumnos </td>
+          <td>(</td>
+          <td class="paramtype">char *&#160;</td>
+          <td class="paramname"><em>cadena</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">size_t&#160;</td>
+          <td class="paramname"><em>espacio</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<dl class="params"><dt>Parámetros</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">cadena</td><td>cadena donde se quiere guardar la serialización </td></tr>
+    <tr><td class="paramname">espacio</td><td>espacio de memoria que ocupa el string cadena </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Devuelve</dt><dd>true: se serializo correctamente </dd>
+<dd>
+false no se pudo serializar </dd></dl>
+
+</div>
+</div>
+</div><!-- contents -->
+<!-- start footer part -->
+<hr class="footer"/><address class="footer"><small>
+Generado por &#160;<a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/>
+</a> 1.8.13
+</small></address>
+</body>
+</html>
-Original file line number
+Diff line change
@@ -1 +1,2 @@
-    build
+    build
+    doc