diff options
| author | bors <bors@rust-lang.org> | 2015-12-13 15:22:03 +0000 |
|---|---|---|
| committer | bors <bors@rust-lang.org> | 2015-12-13 15:22:03 +0000 |
| commit | d5cdf0687e3ef56940b61b4d2bbfc953afeacac5 (patch) | |
| tree | 95cb414173059b512ff0a8f049c6fe6ae370f141 /src/libcore | |
| parent | 33378f09fdd47cd88e7b9702b6a28c8cb275031b (diff) | |
| parent | d01ec6cccaf42724e93fe58c42d62f9a01257ca1 (diff) | |
| download | rust-d5cdf0687e3ef56940b61b4d2bbfc953afeacac5.tar.gz rust-d5cdf0687e3ef56940b61b4d2bbfc953afeacac5.zip | |
Auto merge of #30342 - salty-horse:doc_links, r=steveklabnik
Many of the structs in `str` that are used as part of its methods do not have links to the methods. This is especially annoying when a Google search drops you into the documentation of the struct, when you really wanted to get to the method of the same name. This patch adds those links.
Diffstat (limited to 'src/libcore')
| -rw-r--r-- | src/libcore/str/mod.rs | 56 |
1 files changed, 42 insertions, 14 deletions
diff --git a/src/libcore/str/mod.rs b/src/libcore/str/mod.rs index 7aacdbeb768..40bd108a918 100644 --- a/src/libcore/str/mod.rs +++ b/src/libcore/str/mod.rs @@ -292,7 +292,9 @@ Section: Iterators /// Iterator for the char (representing *Unicode Scalar Values*) of a string /// -/// Created with the method `.chars()`. +/// Created with the method [`chars()`]. +/// +/// [`chars()`]: ../primitive.str.html#method.chars #[derive(Clone)] #[stable(feature = "rust1", since = "1.0.0")] pub struct Chars<'a> { @@ -499,7 +501,9 @@ impl<'a> CharIndices<'a> { /// External iterator for a string's bytes. /// Use with the `std::iter` module. /// -/// Created with the method `.bytes()`. +/// Created with the method [`bytes()`]. +/// +/// [`bytes()`]: ../primitive.str.html#method.bytes #[stable(feature = "rust1", since = "1.0.0")] #[derive(Clone)] pub struct Bytes<'a>(Cloned<slice::Iter<'a, u8>>); @@ -782,10 +786,14 @@ impl<'a, P: Pattern<'a>> SplitInternal<'a, P> { generate_pattern_iterators! { forward: - /// Created with the method `.split()`. + /// Created with the method [`split()`]. + /// + /// [`split()`]: ../primitive.str.html#method.split struct Split; reverse: - /// Created with the method `.rsplit()`. + /// Created with the method [`rsplit()`]. + /// + /// [`rsplit()`]: ../primitive.str.html#method.rsplit struct RSplit; stability: #[stable(feature = "rust1", since = "1.0.0")] @@ -796,10 +804,14 @@ generate_pattern_iterators! { generate_pattern_iterators! { forward: - /// Created with the method `.split_terminator()`. + /// Created with the method [`split_terminator()`]. + /// + /// [`split_terminator()`]: ../primitive.str.html#method.split_terminator struct SplitTerminator; reverse: - /// Created with the method `.rsplit_terminator()`. + /// Created with the method [`rsplit_terminator()`]. + /// + /// [`rsplit_terminator()`]: ../primitive.str.html#method.rsplit_terminator struct RSplitTerminator; stability: #[stable(feature = "rust1", since = "1.0.0")] @@ -842,10 +854,14 @@ impl<'a, P: Pattern<'a>> SplitNInternal<'a, P> { generate_pattern_iterators! { forward: - /// Created with the method `.splitn()`. + /// Created with the method [`splitn()`]. + /// + /// [`splitn()`]: ../primitive.str.html#method.splitn struct SplitN; reverse: - /// Created with the method `.rsplitn()`. + /// Created with the method [`rsplitn()`]. + /// + /// [`rsplitn()`]: ../primitive.str.html#method.rsplitn struct RSplitN; stability: #[stable(feature = "rust1", since = "1.0.0")] @@ -880,10 +896,14 @@ impl<'a, P: Pattern<'a>> MatchIndicesInternal<'a, P> { generate_pattern_iterators! { forward: - /// Created with the method `.match_indices()`. + /// Created with the method [`match_indices()`]. + /// + /// [`match_indices()`]: ../primitive.str.html#method.match_indices struct MatchIndices; reverse: - /// Created with the method `.rmatch_indices()`. + /// Created with the method [`rmatch_indices()`]. + /// + /// [`rmatch_indices()`]: ../primitive.str.html#method.rmatch_indices struct RMatchIndices; stability: #[stable(feature = "str_match_indices", since = "1.5.0")] @@ -920,10 +940,14 @@ impl<'a, P: Pattern<'a>> MatchesInternal<'a, P> { generate_pattern_iterators! { forward: - /// Created with the method `.matches()`. + /// Created with the method [`matches()`]. + /// + /// [`matches()`]: ../primitive.str.html#method.matches struct Matches; reverse: - /// Created with the method `.rmatches()`. + /// Created with the method [`rmatches()`]. + /// + /// [`rmatches()`]: ../primitive.str.html#method.rmatches struct RMatches; stability: #[stable(feature = "str_matches", since = "1.2.0")] @@ -932,7 +956,9 @@ generate_pattern_iterators! { delegate double ended; } -/// Created with the method `.lines()`. +/// Created with the method [`lines()`]. +/// +/// [`lines()`]: ../primitive.str.html#method.lines #[stable(feature = "rust1", since = "1.0.0")] #[derive(Clone)] pub struct Lines<'a>(Map<SplitTerminator<'a, char>, LinesAnyMap>); @@ -960,7 +986,9 @@ impl<'a> DoubleEndedIterator for Lines<'a> { } } -/// Created with the method `.lines_any()`. +/// Created with the method [`lines_any()`]. +/// +/// [`lines_any()`]: ../primitive.str.html#method.lines_any #[stable(feature = "rust1", since = "1.0.0")] #[rustc_deprecated(since = "1.4.0", reason = "use lines()/Lines instead now")] #[derive(Clone)] |
