Permalink
Browse files

Doc fixes

  • Loading branch information...
1 parent 66614b3 commit 84887da4ad7059e963f478d18405b1a475156817 @tj tj committed Aug 22, 2010
Showing with 7 additions and 7 deletions.
  1. +7 −7 Readme.md
View
@@ -9,23 +9,23 @@
Allocate and initialize a `List`.
-### ListNode *ListNode_new(void *val)
+### ListNode \*ListNode_new(void *val)
Allocate and initialize a `ListNode` with the given _val_.
-### List_push(List *self, ListNode *node)
+### List_push(List \*self, ListNode *node)
Append _node_ to _self_, returning _node_.
-### ListNode *List_unshift(List *self, ListNode *node)
+### ListNode \*List_unshift(List \*self, ListNode *node)
Prepend _node_ to _self_, returning _node_.
-### ListNode *List_find(List *self, void *val)
+### ListNode \*List_find(List \*self, void *val)
Return the `ListNode` containing _val_ or __NULL__.
-### ListNode *List_at(List *self, int index)
+### ListNode \*List_at(List *self, int index)
Return the `ListNode` at the given _index_, where _index_
may also be a negative integer indicating an index from the
@@ -36,15 +36,15 @@
List_at(list, -1); // last
List_at(list, -3); // third last
-### void List_remove(List *self, ListNode *node)
+### void List_remove(List \*self, ListNode *node)
Remove _node_ from the list.
### void List_destroy(List *self)
Free the list and all nodes.
-### ListIterator *ListIterator_new(List *list, ListDirection direction)
+### ListIterator \*ListIterator_new(List *list, ListDirection direction)
Allocate and initialize a `ListIterator` with the given _direction_,
where _direction_ may be __LIST_HEAD__ or __LIST_TAIL__.

0 comments on commit 84887da

Please sign in to comment.