mem: Add documentation for newly introduced functions

Author: dominikw1

Diff for: kernel/src/mem/array.rs

@@ -170,6 +170,11 @@ impl<T: Clone + Copy, const N: usize> Vec<T, N> {
         Ok(())
     }
 
+    /// Reserve a fixed amount of space in the Vec. Does nothing if enough space is present already.
+    ///
+    /// `total_capacity` - The total space to be reserved.
+    ///
+    /// Returns `Ok(())` if the space was reserved, otherwise `Err(KernelError::OutOfMemory)`.
     pub fn reserve_total_capacity(&mut self, total_capacity: usize) -> Result<(), KernelError> {
         // Check if we already have enough space
         if self.capacity() >= total_capacity {
@@ -405,6 +410,9 @@ impl<T: Clone + Copy, const N: usize> Vec<T, N> {
         self.len == 0
     }
 
+    /// Get total amount of space in Vec (in- and out-of-line)
+    ///
+    /// Returns total amount of  reserved space in the vec
     pub fn capacity(&self) -> usize {
         N + self.extra.len()
     }

Diff for: kernel/src/mem/queue.rs

@@ -100,6 +100,12 @@ impl<T: Clone + Copy, const N: usize> Queue<T, N> {
         self.len == 0
     }
 
+    /// Increases total space in the queue preserving queue-integrity, potentially reallocating and copying existing contents
+    ///
+    /// `new_size` - The total amount of space in the queue afterwards
+    ///
+    /// Returns `Ok(())` if the queue was successfully enlargened or the requested size was smaller than the current capacity.
+    /// Returns An error if the queue could not be grown
     pub fn grow_capacity(&mut self, new_size: usize) -> Result<(), KernelError> {
         if new_size <= self.data.capacity() {
             return Ok(());