Últimos retoques.

[z.facultad/75.42/calculadora.git] / equation.h

diff --git a/equation.h b/equation.h
index e74252463c65fa109cf7f645d09439b3d546f2eb..49dcc11c4da2a6ec015137cd02f5f983e51ba456 100644 (file)
--- a/equation.h
+++ b/equation.h
@@ -20,16 +20,45 @@
 #include <stdlib.h>
 #include <stdio.h>
 
+/**
+ * Ecuación.
+ */
 typedef struct {
+    /** Nombre de la variable. */
     char* variable;
+    /** Expresión. */
     char* expression;
 } Equation;
 
+/**
+ * Crea una nueva Equation.
+ *
+ * \param line Cadena de caracteres de donde extraer la Equation.
+ * \param var_start Comienzo del nombre de la variable.
+ * \param var_len Longitud de la variable.
+ * \param exp_start Comienzo de la expresión.
+ * \param exp_len Longitud de la expresión.
+ *
+ * \return Nueva Equation.
+ */
 Equation* Equation_new(const char* line, size_t var_start, size_t var_len,
         size_t exp_start, size_t exp_len);
 
+/**
+ * Elimina una Equation.
+ *
+ * \param eq Equation a eliminar.
+ */
 void Equation_delete(Equation* eq);
 
+/**
+ * Imprime una Equation.
+ *
+ * \param eq Equation a imprimir.
+ * \param fp Archivo donde imprimirla.
+ *
+ * \return Cantidad de caracteres impresos.
+ */
 size_t Equation_print(Equation* eq, FILE* fp);
 
 #endif /* EQUATION_H */