mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Throw errors when doc comments are added where they're unused

Browse Source
This commit is contained in:
Guillaume Gomez 2017-07-02 01:37:47 +02:00
parent 0565653eec
commit 7e70a63e61
6 changed files with 111 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/librustc/hir/mod.rs
View File

@ -1679,7 +1679,7 @@ pub struct Item {
#[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
pub enum Item_ {
/// An`extern crate` item, with optional original crate name,
/// An `extern crate` item, with optional original crate name,
///
/// e.g. `extern crate foo` or `extern crate foo_bar as foo`
ItemExternCrate(Option<Name>),

41
src/libsyntax/parse/parser.rs
View File

@ -2131,14 +2131,14 @@ fn parse_bottom_expr(&mut self) -> PResult<'a, P<Expr>> {
} else {
Ok(self.mk_expr(span, ExprKind::Tup(es), attrs))
}
},
}
token::OpenDelim(token::Brace) => {
return self.parse_block_expr(lo, BlockCheckMode::Default, attrs);
},
token::BinOp(token::Or) | token::OrOr => {
}
token::BinOp(token::Or) | token::OrOr => {
let lo = self.span;
return self.parse_lambda_expr(lo, CaptureBy::Ref, attrs);
},
}
token::OpenDelim(token::Bracket) => {
self.bump();
@ -2387,7 +2387,6 @@ fn parse_or_use_outer_attributes(&mut self,
pub fn parse_block_expr(&mut self, lo: Span, blk_mode: BlockCheckMode,
outer_attrs: ThinVec<Attribute>)
-> PResult<'a, P<Expr>> {
self.expect(&token::OpenDelim(token::Brace))?;
let mut attrs = outer_attrs;
@ -2421,6 +2420,12 @@ pub fn parse_dot_or_call_expr_with(&mut self,
expr.map(|mut expr| {
attrs.extend::<Vec<_>>(expr.attrs.into());
expr.attrs = attrs;
if if let Some(ref doc) = expr.attrs.iter().find(|x| x.is_sugared_doc) {
self.span_fatal_err(doc.span, Error::UselessDocComment).emit();
true
} else { false } {
return expr;
}
match expr.node {
ExprKind::If(..) | ExprKind::IfLet(..) => {
if !expr.attrs.is_empty() {
@ -3105,6 +3110,9 @@ pub fn parse_lambda_expr(&mut self,
// `else` token already eaten
pub fn parse_else_expr(&mut self) -> PResult<'a, P<Expr>> {
if self.prev_token_kind == PrevTokenKind::DocComment {
return Err(self.span_fatal_err(self.span, Error::UselessDocComment));
}
if self.eat_keyword(keywords::If) {
return self.parse_if_expr(ThinVec::new());
} else {
@ -3118,6 +3126,9 @@ pub fn parse_for_expr(&mut self, opt_ident: Option<ast::SpannedIdent>,
span_lo: Span,
mut attrs: ThinVec<Attribute>) -> PResult<'a, P<Expr>> {
// Parse: `for <src_pat> in <src_expr> <src_loop_block>`
if let Some(doc) = attrs.iter().find(|x| x.is_sugared_doc) {
self.span_fatal_err(doc.span, Error::UselessDocComment).emit();
}
let pat = self.parse_pat()?;
self.expect_keyword(keywords::In)?;
@ -3133,6 +3144,9 @@ pub fn parse_for_expr(&mut self, opt_ident: Option<ast::SpannedIdent>,
pub fn parse_while_expr(&mut self, opt_ident: Option<ast::SpannedIdent>,
span_lo: Span,
mut attrs: ThinVec<Attribute>) -> PResult<'a, P<Expr>> {
if let Some(doc) = attrs.iter().find(|x| x.is_sugared_doc) {
self.span_fatal_err(doc.span, Error::UselessDocComment).emit();
}
if self.token.is_keyword(keywords::Let) {
return self.parse_while_let_expr(opt_ident, span_lo, attrs);
}
@ -3161,6 +3175,9 @@ pub fn parse_while_let_expr(&mut self, opt_ident: Option<ast::SpannedIdent>,
pub fn parse_loop_expr(&mut self, opt_ident: Option<ast::SpannedIdent>,
span_lo: Span,
mut attrs: ThinVec<Attribute>) -> PResult<'a, P<Expr>> {
if let Some(doc) = attrs.iter().find(|x| x.is_sugared_doc) {
self.span_fatal_err(doc.span, Error::UselessDocComment).emit();
}
let (iattrs, body) = self.parse_inner_attrs_and_block()?;
attrs.extend(iattrs);
let span = span_lo.to(body.span);
@ -3171,6 +3188,9 @@ pub fn parse_loop_expr(&mut self, opt_ident: Option<ast::SpannedIdent>,
pub fn parse_catch_expr(&mut self, span_lo: Span, mut attrs: ThinVec<Attribute>)
-> PResult<'a, P<Expr>>
{
if let Some(doc) = attrs.iter().find(|x| x.is_sugared_doc) {
self.span_fatal_err(doc.span, Error::UselessDocComment).emit();
}
let (iattrs, body) = self.parse_inner_attrs_and_block()?;
attrs.extend(iattrs);
Ok(self.mk_expr(span_lo.to(body.span), ExprKind::Catch(body), attrs))
@ -3178,6 +3198,9 @@ pub fn parse_catch_expr(&mut self, span_lo: Span, mut attrs: ThinVec<Attribute>)
// `match` token already eaten
fn parse_match_expr(&mut self, mut attrs: ThinVec<Attribute>) -> PResult<'a, P<Expr>> {
if let Some(doc) = attrs.iter().find(|x| x.is_sugared_doc) {
self.span_fatal_err(doc.span, Error::UselessDocComment).emit();
}
let match_span = self.prev_span;
let lo = self.prev_span;
let discriminant = self.parse_expr_res(RESTRICTION_NO_STRUCT_LITERAL,
@ -3215,6 +3238,9 @@ pub fn parse_arm(&mut self) -> PResult<'a, Arm> {
maybe_whole!(self, NtArm, |x| x);
let attrs = self.parse_outer_attributes()?;
if let Some(doc) = attrs.iter().find(|x| x.is_sugared_doc) {
self.span_fatal_err(doc.span, Error::UselessDocComment).emit();
}
let pats = self.parse_pats()?;
let guard = if self.eat_keyword(keywords::If) {
Some(self.parse_expr()?)
@ -3669,6 +3695,9 @@ fn parse_pat_ident(&mut self,
/// Parse a local variable declaration
fn parse_local(&mut self, attrs: ThinVec<Attribute>) -> PResult<'a, P<Local>> {
if let Some(doc) = attrs.iter().find(|x| x.is_sugared_doc) {
self.span_fatal_err(doc.span, Error::UselessDocComment).emit();
}
let lo = self.span;
let pat = self.parse_pat()?;
@ -4158,6 +4187,8 @@ fn parse_block_tail(&mut self, lo: Span, s: BlockCheckMode) -> PResult<'a, P<Blo
stmts.push(stmt);
} else if self.token == token::Eof {
break;
} else if let token::DocComment(_) = self.token {
return Err(self.span_fatal_err(self.span, Error::UselessDocComment));
} else {
// Found only `;` or `}`.
continue;

2
src/test/compile-fail/issue-34222.rs
View File

@ -13,6 +13,6 @@
#[rustc_error]
fn main() { //~ ERROR compilation successful
/// crash
// crash
let x = 0;
}

26
src/test/compile-fail/useless_comment.rs Normal file
View File

@ -0,0 +1,26 @@
// Copyright 2017 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.
fn foo3() -> i32 {
let mut x = 12;
/// z //~ ERROR E0585
while x < 1 {
/// x //~ ERROR E0585
//~^ ERROR attributes on non-item statements and expressions are experimental
x += 1;
}
/// d //~ ERROR E0585
return x;
}
fn main() {
/// e //~ ERROR E0585
foo3();
}

25
src/test/compile-fail/useless_comment2.rs Normal file
View File

@ -0,0 +1,25 @@
// Copyright 2017 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.
fn foo() {
/// a //~ ERROR E0585
let x = 12;
/// b //~ ERROR E0585
match x {
/// c //~ ERROR E0585
1 => {},
_ => {}
}
}
fn main() {
foo();
}

22
src/test/compile-fail/useless_comment3.rs Normal file
View File

@ -0,0 +1,22 @@
// Copyright 2017 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.
fn foo() {
let x = 13;
/// x //~ ERROR E0585
if x == 12 {
/// y
println!("hello");
}
}
fn main() {
foo();
}