From: Mike D. Lowis <mike@mdlowis.com>
Date: Sat, 8 Dec 2012 03:42:01 +0000 (-0500)
Subject: Updated doxygen for linked list
X-Git-Url: https://git.mdlowis.com/?a=commitdiff_plain;h=a7d59909e6e02a35701dcd4d36c54c73a1345c57;p=projs%2Flibcds.git

Updated doxygen for linked list
---

diff --git a/source/list/sll.h b/source/list/sll.h
index ea3bd0f..5bf95f8 100644
--- a/source/list/sll.h
+++ b/source/list/sll.h
@@ -8,18 +8,18 @@ extern "C" {
 /** A linked list node. */
 typedef struct sll_node_t
 {
-    /* Pointer to the contents the node */
+    /** Pointer to the contents the node */
     void* contents;
-    /* Pointer to next node in the list. */
+    /** Pointer to next node in the list. */
     struct sll_node_t* next;
 } sll_node_t;
 
-/* A singly linked list */
+/** A singly linked list */
 typedef struct sll_t
 {
-    /* Pointer to the first element in the list */
+    /** Pointer to the first element in the list */
     sll_node_t* head;
-    /* Pointer to the last element in the list */
+    /** Pointer to the last element in the list */
     sll_node_t* tail;
 } sll_t;
 
@@ -62,20 +62,20 @@ void sll_free(sll_t* list, int free_contents);
 void sll_free_node(sll_node_t* node, int free_contents);
 
 /**
- * @brief
+ * @brief Returns pointer to first node in the list
  *
- * @param list
+ * @param list The list from which to retrieve elements.
  *
- * @return
+ * @return Pointer to the first element in the list.
  */
 sll_node_t* sll_front( sll_t* list );
 
 /**
- * @brief
+ * @brief Returns pointer to the last element in the list.
  *
- * @param list
+ * @param The list from which to retrieve elements.
  *
- * @return
+ * @return Pointer to the last element in the list.
  */
 sll_node_t* sll_back( sll_t* list );