X-Git-Url: https://git.llucax.com/z.facultad/75.42/calculadora.git/blobdiff_plain/745520d79002f4380743f3a063202a387cc465fc..f9f95299e9949f6b3ee440b5055bb155ce0b0d74:/dllist.h diff --git a/dllist.h b/dllist.h index d9ad1f7..432e742 100644 --- a/dllist.h +++ b/dllist.h @@ -37,7 +37,13 @@ struct DLNodeStruct { DLNode* next; }; -/** Lista doblemente enlazada. */ +/** + * Lista doblemente enlazada. + * + * \see DLList_init(), DLList_empty(), DLList_begin(), DLList_end(), + * DLList_have_more(), DLList_current(), DLList_next(), DLList_prev(), + * DLList_unshift(), DLList_push(), DLList_shift(), DLList_pop() + */ typedef struct { /** Puntero al primer nodo. */ DLNode* first; @@ -52,7 +58,7 @@ typedef struct { * * \param list DLList a inicializar. * - * \return TRUE si se inicializó bien, FALSE si hay error. + * \return \ref TRUE si se inicializó bien, \ref FALSE si hay error. */ bool DLList_init(DLList* list); @@ -61,7 +67,7 @@ bool DLList_init(DLList* list); * * \param list DLList a verificar. * - * \return TRUE si está vacía, FALSE si no. + * \return \ref TRUE si está vacía, \ref FALSE si no. * \pre La DLList debe estar \ref DLList_init "inicializada". */ bool DLList_empty(DLList* list); @@ -117,7 +123,7 @@ void* DLList_end(DLList* list); * * \param list DLList a verificar. * - * \return TRUE si se puede obtener otro elemento, FALSE si no. + * \return \ref TRUE si se puede obtener otro elemento, \ref FALSE si no. * \see DLList_begin(), DLList_end(), DLList_prev(), DLList_next() * \pre La DLList debe estar \ref DLList_init "inicializada". */ @@ -162,7 +168,7 @@ void* DLList_prev(DLList* list); * \param list DLList a la cual agregar el elemento. * \param data Elemento a agregar. * - * \return TRUE si se agregó, FALSE si no hay más memoria. + * \return \ref TRUE si se agregó, \ref FALSE si no hay más memoria. * \see DLList_push(), DLList_pop(), DLList_unshift() * \pre La DLList debe estar \ref DLList_init "inicializada". * \post El puntero interno de la DLList apunta al nuevo elemento. @@ -175,7 +181,7 @@ bool DLList_unshift(DLList* list, void* data); * \param list DLList a la cual agregar el elemento. * \param data Elemento a agregar. * - * \return TRUE si se agregó, FALSE si no hay más memoria. + * \return \ref TRUE si se agregó, \ref FALSE si no hay más memoria. * \see DLList_pop(), DLList_shift(), DLList_unshift() * \pre La DLList debe estar \ref DLList_init "inicializada". * \post El puntero interno de la DLList apunta al nuevo elemento.