1
Fork 0

Auto merge of #26313 - steveklabnik:fix_str_docs, r=alexcrichton

Because these structures are created by a macro, the doc comments
don't quite work: the leading /// isn't stripped. Instead, just
use #[doc] so that they render correctly.
This commit is contained in:
bors 2015-06-16 01:57:34 +00:00
commit af8a4a0805

View file

@ -638,10 +638,10 @@ impl<'a, P: Pattern<'a>> SplitInternal<'a, P> {
generate_pattern_iterators! { generate_pattern_iterators! {
forward: forward:
/// Created with the method `.split()`. #[doc="Created with the method `.split()`."]
struct Split; struct Split;
reverse: reverse:
/// Created with the method `.rsplit()`. #[doc="Created with the method `.rsplit()`."]
struct RSplit; struct RSplit;
stability: stability:
#[stable(feature = "rust1", since = "1.0.0")] #[stable(feature = "rust1", since = "1.0.0")]
@ -652,10 +652,10 @@ generate_pattern_iterators! {
generate_pattern_iterators! { generate_pattern_iterators! {
forward: forward:
/// Created with the method `.split_terminator()`. #[doc="Created with the method `.split_terminator()`."]
struct SplitTerminator; struct SplitTerminator;
reverse: reverse:
/// Created with the method `.rsplit_terminator()`. #[doc="Created with the method `.rsplit_terminator()`."]
struct RSplitTerminator; struct RSplitTerminator;
stability: stability:
#[stable(feature = "rust1", since = "1.0.0")] #[stable(feature = "rust1", since = "1.0.0")]
@ -698,10 +698,10 @@ impl<'a, P: Pattern<'a>> SplitNInternal<'a, P> {
generate_pattern_iterators! { generate_pattern_iterators! {
forward: forward:
/// Created with the method `.splitn()`. #[doc="Created with the method `.splitn()`."]
struct SplitN; struct SplitN;
reverse: reverse:
/// Created with the method `.rsplitn()`. #[doc="Created with the method `.rsplitn()`."]
struct RSplitN; struct RSplitN;
stability: stability:
#[stable(feature = "rust1", since = "1.0.0")] #[stable(feature = "rust1", since = "1.0.0")]
@ -732,10 +732,10 @@ impl<'a, P: Pattern<'a>> MatchIndicesInternal<'a, P> {
generate_pattern_iterators! { generate_pattern_iterators! {
forward: forward:
/// Created with the method `.match_indices()`. #[doc="Created with the method `.match_indices()`."]
struct MatchIndices; struct MatchIndices;
reverse: reverse:
/// Created with the method `.rmatch_indices()`. #[doc="Created with the method `.rmatch_indices()`."]
struct RMatchIndices; struct RMatchIndices;
stability: stability:
#[unstable(feature = "core", #[unstable(feature = "core",
@ -773,10 +773,10 @@ impl<'a, P: Pattern<'a>> MatchesInternal<'a, P> {
generate_pattern_iterators! { generate_pattern_iterators! {
forward: forward:
/// Created with the method `.matches()`. #[doc="Created with the method `.matches()`."]
struct Matches; struct Matches;
reverse: reverse:
/// Created with the method `.rmatches()`. #[doc="Created with the method `.rmatches()`."]
struct RMatches; struct RMatches;
stability: stability:
#[unstable(feature = "core", reason = "type got recently added")] #[unstable(feature = "core", reason = "type got recently added")]