motiejus/zig
1
Fork 0
Code Releases Activity

stage2: make same line doc comments a parse error

Browse Source 
Allowing same line doc comments causes some ambiguity as to how
generated docs should represent the case in which both same line
and preceding line doc comments are present:

/// preceding line
const foobar = 42; /// same line

Furthermore disallowing these makes things simpler as there is now only
one way to add a doc comment to a decl or struct field.
This commit is contained in:
Isaac Freund
2021-02-19 22:54:47 +01:00
parent 6f6568b1fd
commit 95b95ea33e
3 changed files with 39 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
lib/std/zig/parser_test.zig
View File

@@ -1016,23 +1016,6 @@ test "zig fmt: linksection" {
);
}
//test "zig fmt: correctly move doc comments on struct fields" {
// try testTransform(
// \\pub const section_64 = extern struct {
// \\ sectname: [16]u8, /// name of this section
// \\ segname: [16]u8, /// segment this section goes in
// \\};
// ,
// \\pub const section_64 = extern struct {
// \\ /// name of this section
// \\ sectname: [16]u8,
// \\ /// segment this section goes in
// \\ segname: [16]u8,
// \\};
// \\
// );
//}
test "zig fmt: correctly space struct fields with doc comments" {
try testTransform(
\\pub const S = struct {
@@ -1449,31 +1432,6 @@ test "zig fmt: async call in if condition" {
// \\
// );
//}
//
//test "zig fmt: same-line doc comment on variable declaration" {
// try testTransform(
// \\pub const MAP_ANONYMOUS = 0x1000; /// allocated from memory, swap space
// \\pub const MAP_FILE = 0x0000; /// map from file (default)
// \\
// \\pub const EMEDIUMTYPE = 124; /// Wrong medium type
// \\
// \\// nameserver query return codes
// \\pub const ENSROK = 0; /// DNS server returned answer with no data
// ,
// \\/// allocated from memory, swap space
// \\pub const MAP_ANONYMOUS = 0x1000;
// \\/// map from file (default)
// \\pub const MAP_FILE = 0x0000;
// \\
// \\/// Wrong medium type
// \\pub const EMEDIUMTYPE = 124;
// \\
// \\// nameserver query return codes
// \\/// DNS server returned answer with no data
// \\pub const ENSROK = 0;
// \\
// );
//}
test "zig fmt: if-else with comment before else" {
try testCanonical(
@@ -3625,6 +3583,30 @@ test "zig fmt: file ends with struct field" {
// });
//}
test "zig fmt: same line doc comment returns error" {
try testError(
\\const Foo = struct{
\\ bar: u32, /// comment
\\ foo: u32, /// comment
\\ /// commment
\\};
\\
\\const a = 42; /// comment
\\
\\extern fn foo() void; /// comment
\\
\\/// comment
\\
, &[_]Error{
.SameLineDocComment,
.SameLineDocComment,
.UnattachedDocComment,
.SameLineDocComment,
.SameLineDocComment,
.UnattachedDocComment,
});
}
test "zig fmt: integer literals with underscore separators" {
try testTransform(
\\const
@@ -4388,6 +4370,6 @@ fn testError(source: []const u8, expected_errors: []const Error) !void {
std.testing.expect(tree.errors.len == expected_errors.len);
for (expected_errors) |expected, i| {
std.testing.expect(expected == tree.errors[i]);
std.testing.expectEqual(expected, tree.errors[i]);
}
}