xous: correct comments on IncreaseHeap and DecreaseHeap

These were behaving differently from what they were documented to do.

Signed-off-by: Sean Cross <sean@xobs.io>
This commit is contained in:
Sean Cross 2022-06-15 12:35:05 +08:00
parent b31c727f81
commit ed4763c714

View file

@ -72,12 +72,14 @@ pub enum SysCall {
/// Add the given number of bytes to the heap. The number of bytes must be
/// divisible by the page size. The newly-allocated pages will have the
/// specified flags. To get the current heap base, call this with a size of
/// `0`.
/// `0`, which will return a `MemoryRange` containing the heap base and the size.
///
/// # Returns
///
/// * **MemoryRange(*mut usize /* The base of the heap */, usize /* the new
/// size of the heap */)
/// * **MemoryRange(
/// *mut usize, /* The newly-allocated offset */
/// usize, /* The amount of data added */
/// )**
///
/// # Errors
///