From: Joshua Simmons <josh@nega.tv>
Date: Sat, 4 Mar 2023 13:11:49 +0000 (+0100)
Subject: Fix doc comments
X-Git-Url: https://git.nega.tv//gitweb.cgi?a=commitdiff_plain;h=ee8b324af1893bc7fd965402cd5ece1d09f08ef5;p=josh%2Fnarcissus

Fix doc comments
---

diff --git a/libs/ffi/vulkan-sys/src/enums.rs b/libs/ffi/vulkan-sys/src/enums.rs
index 2a98f0b..4d8ce08 100644
--- a/libs/ffi/vulkan-sys/src/enums.rs
+++ b/libs/ffi/vulkan-sys/src/enums.rs
@@ -21,7 +21,7 @@ pub enum Result {
     ErrorOutOfDeviceMemory = -2,
     ///  Initialization of a object has failed
     ErrorInitializationFailed = -3,
-    ///  The logical device has been lost. See <<devsandqueues-lost-device>>
+    ///  The logical device has been lost.
     ErrorDeviceLost = -4,
     ///  Mapping of a memory object has failed
     ErrorMemoryMapFailed = -5,
diff --git a/libs/narcissus-core/src/lib.rs b/libs/narcissus-core/src/lib.rs
index c8e1ad3..b57b5cb 100644
--- a/libs/narcissus-core/src/lib.rs
+++ b/libs/narcissus-core/src/lib.rs
@@ -282,7 +282,7 @@ pub fn zeroed_box<T>() -> Box<MaybeUninit<T>> {
 /// is in an initialized state. Calling this when the content is not yet fully initialized causes
 /// immediate undefined behavior.
 ///
-/// [`MaybeUninit::assume_init`]: mem::MaybeUninit::assume_init
+/// [`MaybeUninit::assume_init`]: std::mem::MaybeUninit::assume_init
 #[inline]
 pub unsafe fn box_assume_init<T>(value: Box<MaybeUninit<T>>) -> Box<T> {
     let raw = Box::into_raw(value);
diff --git a/libs/narcissus-core/src/slice.rs b/libs/narcissus-core/src/slice.rs
index 66713a2..12ac631 100644
--- a/libs/narcissus-core/src/slice.rs
+++ b/libs/narcissus-core/src/slice.rs
@@ -375,11 +375,6 @@ pub fn array_chunks_mut<T, const N: usize>(slice: &mut [T]) -> ArrayChunksMut<'_
 /// This may only be called when
 /// - The slice splits exactly into `N`-element chunks (aka `self.len() % N == 0`).
 /// - `N != 0`.
-///
-/// // These would be unsound:
-/// // let chunks: &[[_; 5]] = slice.as_chunks_unchecked() // The slice length is not a multiple of 5
-/// // let chunks: &[[_; 0]] = slice.as_chunks_unchecked() // Zero-length chunks are never allowed
-/// ```
 #[inline]
 #[must_use]
 pub unsafe fn as_chunks_unchecked<T, const N: usize>(slice: &[T]) -> &[[T; N]] {
@@ -419,11 +414,6 @@ pub fn as_chunks<T, const N: usize>(slice: &[T]) -> (&[[T; N]], &[T]) {
 /// This may only be called when
 /// - The slice splits exactly into `N`-element chunks (aka `self.len() % N == 0`).
 /// - `N != 0`.
-///
-/// // These would be unsound:
-/// // let chunks: &[[_; 5]] = slice.as_chunks_unchecked_mut() // The slice length is not a multiple of 5
-/// // let chunks: &[[_; 0]] = slice.as_chunks_unchecked_mut() // Zero-length chunks are never allowed
-/// ```
 #[inline]
 #[must_use]
 pub unsafe fn as_chunks_unchecked_mut<T, const N: usize>(slice: &mut [T]) -> &mut [[T; N]] {
@@ -443,7 +433,6 @@ pub unsafe fn as_chunks_unchecked_mut<T, const N: usize>(slice: &mut [T]) -> &mu
 ///
 /// Panics if `N` is 0. This check will most probably get changed to a compile time
 /// error before this method gets stabilized.
-/// ```
 #[inline]
 #[must_use]
 pub fn as_chunks_mut<T, const N: usize>(slice: &mut [T]) -> (&mut [[T; N]], &mut [T]) {