]> git.lizzy.rs Git - rust.git/commitdiff
Indicate how the `std::path::Components` struct is created.
authorCorey Farwell <coreyf@rwell.org>
Sat, 25 Jun 2016 14:05:01 +0000 (10:05 -0400)
committerCorey Farwell <coreyf@rwell.org>
Sat, 25 Jun 2016 14:05:01 +0000 (10:05 -0400)
src/libstd/path.rs

index f413bed86a8534d3c67844d380629ea49cf756bc..afcb75ed22ed9414c0b6e48be7a7479d8188d989 100644 (file)
@@ -579,6 +579,8 @@ fn as_ref(&self) -> &OsStr {
 /// See the module documentation for an in-depth explanation of components and
 /// their role in the API.
 ///
+/// This `struct` is created by the [`path::Path::components`] method.
+///
 /// # Examples
 ///
 /// ```
@@ -590,6 +592,8 @@ fn as_ref(&self) -> &OsStr {
 ///     println!("{:?}", component);
 /// }
 /// ```
+///
+/// [`path::Path::components`]: struct.Path.html#method.components
 #[derive(Clone)]
 #[stable(feature = "rust1", since = "1.0.0")]
 pub struct Components<'a> {