Skip to content

Commit

Permalink
auto merge of #6680 : ben0x539/rust/slashslashslash, r=graydon
Browse files Browse the repository at this point in the history
There's currently a function in the lexer that rejects a line comment that is all slashes from being a doc comment. I think the intention was that you could draw boxes,

    /////////////
    // like so //
    /////////////

Since a line doc comment split up over multiple paragraphs will have a "blank" line that is just /// between the paragraphs, that would get mistaken for a box segment, lexed as a regular comment, and go missing from the sequence of doc comment attributes before they were reassembled by rustdoc into markdown input.

I figure the best plan here is to just declare that a comment that is exactly `///` is a doc comment after all, and to only omit comments with four slashes or more, which is what this commit implements. Can't really draw boxes that narrow, anyway.
  • Loading branch information
bors committed May 24, 2013
2 parents 2f69bb9 + 5a42481 commit b5ab101
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions src/libsyntax/parse/lexer.rs
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,8 @@ fn consume_whitespace_and_comments(rdr: @mut StringReader)
}

pub fn is_line_non_doc_comment(s: &str) -> bool {
s.trim_right().all(|ch| ch == '/')
let s = s.trim_right();
s.len() > 3 && s.all(|ch| ch == '/')
}

// PRECONDITION: rdr.curr is not whitespace
Expand All @@ -268,7 +269,7 @@ fn consume_any_line_comment(rdr: @mut StringReader)
str::push_char(&mut acc, rdr.curr);
bump(rdr);
}
// but comments with only "/"s are not
// but comments with only more "/"s are not
if !is_line_non_doc_comment(acc) {
return Some(TokenAndSpan{
tok: token::DOC_COMMENT(rdr.interner.intern(acc)),
Expand Down Expand Up @@ -891,4 +892,10 @@ mod test {
let id = env.interner.intern("abc");
assert_eq!(tok, token::LIFETIME(id));
}

#[test] fn line_doc_comments() {
assert!(!is_line_non_doc_comment("///"));
assert!(!is_line_non_doc_comment("/// blah"));
assert!(is_line_non_doc_comment("////"));
}
}

0 comments on commit b5ab101

Please sign in to comment.