]> git.lizzy.rs Git - rust.git/commitdiff
Add hyperlinks to `std::fs` functions from `std::path`.
authorCorey Farwell <coreyf@rwell.org>
Sat, 25 Jun 2016 13:26:41 +0000 (09:26 -0400)
committerCorey Farwell <coreyf@rwell.org>
Sat, 25 Jun 2016 13:26:41 +0000 (09:26 -0400)
src/libstd/path.rs

index f413bed86a8534d3c67844d380629ea49cf756bc..a19d51fac3552130d7752041fc8de04b6e06efcc 100644 (file)
@@ -1781,7 +1781,9 @@ pub fn display(&self) -> Display {
     /// This function will traverse symbolic links to query information about the
     /// destination file.
     ///
-    /// This is an alias to `fs::metadata`.
+    /// This is an alias to [`fs::metadata`].
+    ///
+    /// [`fs::metadata`]: ../fs/fn.metadata.html
     #[stable(feature = "path_ext", since = "1.5.0")]
     pub fn metadata(&self) -> io::Result<fs::Metadata> {
         fs::metadata(self)
@@ -1789,7 +1791,9 @@ pub fn metadata(&self) -> io::Result<fs::Metadata> {
 
     /// Query the metadata about a file without following symlinks.
     ///
-    /// This is an alias to `fs::symlink_metadata`.
+    /// This is an alias to [`fs::symlink_metadata`].
+    ///
+    /// [`fs::symlink_metadata`]: ../fs/fn.symlink_metadata.html
     #[stable(feature = "path_ext", since = "1.5.0")]
     pub fn symlink_metadata(&self) -> io::Result<fs::Metadata> {
         fs::symlink_metadata(self)
@@ -1798,7 +1802,9 @@ pub fn symlink_metadata(&self) -> io::Result<fs::Metadata> {
     /// Returns the canonical form of the path with all intermediate components
     /// normalized and symbolic links resolved.
     ///
-    /// This is an alias to `fs::canonicalize`.
+    /// This is an alias to [`fs::canonicalize`].
+    ///
+    /// [`fs::canonicalize`]: ../fs/fn.canonicalize.html
     #[stable(feature = "path_ext", since = "1.5.0")]
     pub fn canonicalize(&self) -> io::Result<PathBuf> {
         fs::canonicalize(self)
@@ -1806,7 +1812,9 @@ pub fn canonicalize(&self) -> io::Result<PathBuf> {
 
     /// Reads a symbolic link, returning the file that the link points to.
     ///
-    /// This is an alias to `fs::read_link`.
+    /// This is an alias to [`fs::read_link`].
+    ///
+    /// [`fs::read_link`]: ../fs/fn.read_link.html
     #[stable(feature = "path_ext", since = "1.5.0")]
     pub fn read_link(&self) -> io::Result<PathBuf> {
         fs::read_link(self)
@@ -1817,7 +1825,9 @@ pub fn read_link(&self) -> io::Result<PathBuf> {
     /// The iterator will yield instances of `io::Result<DirEntry>`. New errors may
     /// be encountered after an iterator is initially constructed.
     ///
-    /// This is an alias to `fs::read_dir`.
+    /// This is an alias to [`fs::read_dir`].
+    ///
+    /// [`fs::read_dir`]: ../fs/fn.read_dir.html
     #[stable(feature = "path_ext", since = "1.5.0")]
     pub fn read_dir(&self) -> io::Result<fs::ReadDir> {
         fs::read_dir(self)