libavl: fix documentation
This commit is contained in:
parent
403584715f
commit
1f6a604c23
1 changed files with 5 additions and 2 deletions
|
@ -57,10 +57,13 @@ from the tree and may be freed.
|
||||||
.I Avllookup
|
.I Avllookup
|
||||||
searches for a given key and returns
|
searches for a given key and returns
|
||||||
the closest node less than the given key,
|
the closest node less than the given key,
|
||||||
.BR nil ,
|
equal to,
|
||||||
or the closest node greater than the key depending on whether
|
or the closest node greater than the key depending on whether
|
||||||
.I dir
|
.I dir
|
||||||
is less than, equal to, or greater than zero, respectively.
|
is less than, equal to, or greater than zero, respectively. If
|
||||||
|
.I dir
|
||||||
|
is zero and there is no matching key, it returns
|
||||||
|
.BR nil .
|
||||||
.I Avldelete
|
.I Avldelete
|
||||||
removes the node matching the key from the tree and returns
|
removes the node matching the key from the tree and returns
|
||||||
it. It returns nil if no matching key is found.
|
it. It returns nil if no matching key is found.
|
||||||
|
|
Loading…
Reference in a new issue