X-Git-Url: https://git.llucax.com/z.facultad/75.42/calculadora.git/blobdiff_plain/f9f95299e9949f6b3ee440b5055bb155ce0b0d74..f7547b1b03c5f2554012658ef7aeafee91c7227c:/dllist.h diff --git a/dllist.h b/dllist.h index 432e742..4a44446 100644 --- a/dllist.h +++ b/dllist.h @@ -191,13 +191,23 @@ bool DLList_push(DLList* list, void* data); /** * Saca el primer elemento de la DLList. * Elimina el primer elemento de la DLList devolviendo su contenido. + * Ejemplo: + * \code + * DLList* l; + * char* data; + * ... + * while (!DLList_empty(l)) { + * data = DLList_shift(l); + * printf("El elemento actual es '%s'.\\n", data); + * } + * \endcode * * \param list DLList de la cual sacar el elemento. * * \return Primer elemento de la DLList. - * \see DLList_push(), DLList_shift(), DLList_unshift() + * \see DLList_empty(), DLList_pop() * \pre La DLList debe estar \ref DLList_init "inicializada" y no - * \ref DLList_empty "vacía". + * \ref DLList_empty "vacía. * \post El puntero interno de la DLList apunta primer elemento. */ void* DLList_shift(DLList* list); @@ -205,13 +215,23 @@ void* DLList_shift(DLList* list); /** * Saca el último elemento de la DLList. * Elimina el último elemento de la DLList devolviendo su contenido. + * Ejemplo: + * \code + * DLList* l; + * char* data; + * ... + * while (!DLList_empty(l)) { + * data = DLList_pop(l); + * printf("El elemento actual es '%s'.\\n", data); + * } + * \endcode * * \param list DLList de la cual sacar el elemento. * - * \return último elemento de la DLList. - * \see DLList_push(), DLList_shift(), DLList_unshift() + * \return Último elemento de la DLList. + * \see DLList_empty(), DLList_shift() * \pre La DLList debe estar \ref DLList_init "inicializada" y no - * \ref DLList_empty "vacía". + * \ref DLList_empty "vacía. * \post El puntero interno de la DLList apunta último elemento. */ void* DLList_pop(DLList* list);