-
Notifications
You must be signed in to change notification settings - Fork 12.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Auto merge of #34292 - ollie27:rustdoc_depr_impl, r=GuillaumeGomez
rustdoc: Add stability notices to impl items Also fixes missing stability notices on methods with no docs. For example [`f64::is_positive`](https://doc.rust-lang.org/nightly/std/primitive.f64.html#method.is_positive) is missing its deprecation message.
- Loading branch information
Showing
2 changed files
with
158 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,128 @@ | ||
// Copyright 2015 The Rust Project Developers. See the COPYRIGHT | ||
// file at the top-level directory of this distribution and at | ||
// http://rust-lang.org/COPYRIGHT. | ||
// | ||
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or | ||
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license | ||
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your | ||
// option. This file may not be copied, modified, or distributed | ||
// except according to those terms. | ||
|
||
#![crate_name = "foo"] | ||
|
||
// @has foo/struct.Foo0.html | ||
pub struct Foo0; | ||
|
||
impl Foo0 { | ||
// @has - '//*[@class="stab deprecated"]' 'Deprecated since 1.0.1: fn_with_doc' | ||
// @has - 'fn_with_doc short' | ||
// @has - 'fn_with_doc full' | ||
/// fn_with_doc short | ||
/// | ||
/// fn_with_doc full | ||
#[deprecated(since = "1.0.1", note = "fn_with_doc")] | ||
pub fn fn_with_doc() {} | ||
|
||
// @has - '//*[@class="stab deprecated"]' 'Deprecated since 1.0.2: fn_without_doc' | ||
#[deprecated(since = "1.0.2", note = "fn_without_doc")] | ||
pub fn fn_without_doc() {} | ||
} | ||
|
||
pub trait Bar { | ||
/// fn_empty_with_doc short | ||
/// | ||
/// fn_empty_with_doc full | ||
#[deprecated(since = "1.0.3", note = "fn_empty_with_doc")] | ||
fn fn_empty_with_doc(); | ||
|
||
#[deprecated(since = "1.0.4", note = "fn_empty_without_doc")] | ||
fn fn_empty_without_doc(); | ||
|
||
/// fn_def_with_doc short | ||
/// | ||
/// fn_def_with_doc full | ||
#[deprecated(since = "1.0.5", note = "fn_def_with_doc")] | ||
fn fn_def_with_doc() {} | ||
|
||
#[deprecated(since = "1.0.6", note = "fn_def_without_doc")] | ||
fn fn_def_without_doc() {} | ||
|
||
/// fn_def_def_with_doc short | ||
/// | ||
/// fn_def_def_with_doc full | ||
#[deprecated(since = "1.0.7", note = "fn_def_def_with_doc")] | ||
fn fn_def_def_with_doc() {} | ||
|
||
#[deprecated(since = "1.0.8", note = "fn_def_def_without_doc")] | ||
fn fn_def_def_without_doc() {} | ||
} | ||
|
||
// @has foo/struct.Foo1.html | ||
pub struct Foo1; | ||
|
||
impl Bar for Foo1 { | ||
// @has - '//*[@class="stab deprecated"]' 'Deprecated since 1.0.3: fn_empty_with_doc' | ||
// @has - 'fn_empty_with_doc_impl short' | ||
// @has - 'fn_empty_with_doc_impl full' | ||
/// fn_empty_with_doc_impl short | ||
/// | ||
/// fn_empty_with_doc_impl full | ||
fn fn_empty_with_doc() {} | ||
|
||
// @has - '//*[@class="stab deprecated"]' 'Deprecated since 1.0.4: fn_empty_without_doc' | ||
fn fn_empty_without_doc() {} | ||
|
||
// @has - '//*[@class="stab deprecated"]' 'Deprecated since 1.0.5: fn_def_with_doc' | ||
// @has - 'fn_def_with_doc_impl short' | ||
// @has - 'fn_def_with_doc_impl full' | ||
/// fn_def_with_doc_impl short | ||
/// | ||
/// fn_def_with_doc_impl full | ||
fn fn_def_with_doc() {} | ||
|
||
// @has - '//*[@class="stab deprecated"]' 'Deprecated since 1.0.6: fn_def_without_doc' | ||
fn fn_def_without_doc() {} | ||
|
||
// @has - '//*[@class="stab deprecated"]' 'Deprecated since 1.0.7: fn_def_def_with_doc' | ||
// @has - 'fn_def_def_with_doc short' | ||
// @!has - 'fn_def_def_with_doc full' | ||
|
||
// @has - '//*[@class="stab deprecated"]' 'Deprecated since 1.0.8: fn_def_def_without_doc' | ||
} | ||
|
||
// @has foo/struct.Foo2.html | ||
pub struct Foo2; | ||
|
||
impl Bar for Foo2 { | ||
// @has - '//*[@class="stab deprecated"]' 'Deprecated since 1.0.3: fn_empty_with_doc' | ||
// @has - 'fn_empty_with_doc short' | ||
// @!has - 'fn_empty_with_doc full' | ||
fn fn_empty_with_doc() {} | ||
|
||
// @has - '//*[@class="stab deprecated"]' 'Deprecated since 1.0.4: fn_empty_without_doc' | ||
// @has - 'fn_empty_without_doc_impl short' | ||
// @has - 'fn_empty_without_doc_impl full' | ||
/// fn_empty_without_doc_impl short | ||
/// | ||
/// fn_empty_without_doc_impl full | ||
fn fn_empty_without_doc() {} | ||
|
||
// @has - '//*[@class="stab deprecated"]' 'Deprecated since 1.0.5: fn_def_with_doc' | ||
// @has - 'fn_def_with_doc short' | ||
// @!has - 'fn_def_with full' | ||
fn fn_def_with_doc() {} | ||
|
||
// @has - '//*[@class="stab deprecated"]' 'Deprecated since 1.0.6: fn_def_without_doc' | ||
// @has - 'fn_def_without_doc_impl short' | ||
// @has - 'fn_def_without_doc_impl full' | ||
/// fn_def_without_doc_impl short | ||
/// | ||
/// fn_def_without_doc_impl full | ||
fn fn_def_without_doc() {} | ||
|
||
// @has - '//*[@class="stab deprecated"]' 'Deprecated since 1.0.7: fn_def_def_with_doc' | ||
// @has - 'fn_def_def_with_doc short' | ||
// @!has - 'fn_def_def_with_doc full' | ||
|
||
// @has - '//*[@class="stab deprecated"]' 'Deprecated since 1.0.8: fn_def_def_without_doc' | ||
} |