WIP docs

cberner · Sep 28, 2024 · 7bbdf0e · 7bbdf0e
1 parent ed5f0f3
commit 7bbdf0e
Showing 1 changed file with 28 additions and 0 deletions.
diff --git a/library/std/src/fs.rs b/library/std/src/fs.rs
@@ -547,6 +547,13 @@ impl File {
     /// unspecified and platform dependent. It may deadlock, it may convert the lock from shared to
     /// exclusive or vice versa, but the requested lock will be held if the function returns.
     ///
+    /// [`lock_shared`]: File::lock_shared
+    /// [`try_lock`]: File::try_lock
+    /// [`try_lock_shared`]: File::try_lock_shared
+    /// [`unlock`]: File::unlock
+    /// [`read`]: Read::read
+    /// [`write`]: Write::write
+    ///
     /// # Examples
     ///
     /// ```no_run
@@ -574,6 +581,13 @@ impl File {
     /// unspecified and platform dependent. It may deadlock, it may convert the lock from shared to
     /// exclusive or vice versa, but the requested lock will be held if the function returns.
     ///
+    /// [`lock`]: File::lock
+    /// [`try_lock`]: File::try_lock
+    /// [`try_lock_shared`]: File::try_lock_shared
+    /// [`unlock`]: File::unlock
+    /// [`read`]: Read::read
+    /// [`write`]: Write::write
+    ///
     /// # Examples
     ///
     /// ```no_run
@@ -602,6 +616,13 @@ impl File {
     /// unspecified and platform dependent. It may deadlock, it may convert the lock from shared to
     /// exclusive or vice versa, but the requested lock will be held if the function returns.
     ///
+    /// [`lock`]: File::lock
+    /// [`lock_shared`]: File::lock_shared
+    /// [`try_lock_shared`]: File::try_lock_shared
+    /// [`unlock`]: File::unlock
+    /// [`read`]: Read::read
+    /// [`write`]: Write::write
+    ///
     /// # Examples
     ///
     /// ```no_run
@@ -630,6 +651,13 @@ impl File {
     /// unspecified and platform dependent. It may deadlock, it may convert the lock from shared to
     /// exclusive or vice versa, but the requested lock will be held if the function returns.
     ///
+    /// [`lock`]: File::lock
+    /// [`lock_shared`]: File::lock_shared
+    /// [`try_lock`]: File::try_lock
+    /// [`unlock`]: File::unlock
+    /// [`read`]: Read::read
+    /// [`write`]: Write::write
+    ///
     /// # Examples
     ///
     /// ```no_run