Skip to content

Commit

Permalink
Correct API documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
P-p-H-d committed May 11, 2024
1 parent 11946f1 commit 000dba1
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3342,16 +3342,18 @@ or NULL if there is no element in the B+Tree.
##### `void name_it_from(name_it_t it, const name_t tree, const type data)`
Set the iterator `it` to the greatest element of `tree`
lower of equal than `data` or the first element is there is none.
Set the iterator `it` to the lowest element of `tree`
greater or equal than `data` or the end iterator is there is none.
##### `bool name_it_until_p(const name_it_t it, const type data)`
Return true if `it` references an element that is greater or equal than `data`.
Return true if `it` references an element that is greater or equal than `data`
or if it references no longer a valid element, false otherwise.
##### `bool name_it_while_p(const name_it_t it, const type data)`
Return true if `it` references an element that is lower or equal than `data`.
Otherwise (or if it references no longer a valid element) it returns false.
_________________
Expand Down

0 comments on commit 000dba1

Please sign in to comment.