Skip to content

Commit a562387

Browse files
authored
Use triple-slash comments in a few tests. (#1458)
This is another small step toward using triple-slash comments everywhere, per the plan in #1362.
1 parent ca92e99 commit a562387

2 files changed

Lines changed: 89 additions & 89 deletions

File tree

crates/wit-parser/tests/ui/types.wit

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ interface types {
5454
type t52 = future<u32>;
5555
type t53 = future;
5656

57-
// type order doesn't matter
57+
/// type order doesn't matter
5858
type foo = bar;
5959
type bar = u32;
6060
}

crates/wit-parser/tests/ui/wasi.wit

Lines changed: 88 additions & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -2,177 +2,177 @@ package wasi:filesystem;
22

33
interface wasi {
44
enum clockid {
5-
// The clock measuring real time. Time value zero corresponds with
6-
// 1970-01-01T00:00:00Z.
5+
/// The clock measuring real time. Time value zero corresponds with
6+
/// 1970-01-01T00:00:00Z.
77
realtime,
8-
// The store-wide monotonic clock, which is defined as a clock measuring
9-
// real time, whose value cannot be adjusted and which cannot have negative
10-
// clock jumps. The epoch of this clock is undefined. The absolute time
11-
// value of this clock therefore has no meaning.
8+
/// The store-wide monotonic clock, which is defined as a clock measuring
9+
/// real time, whose value cannot be adjusted and which cannot have negative
10+
/// clock jumps. The epoch of this clock is undefined. The absolute time
11+
/// value of this clock therefore has no meaning.
1212
monotonic,
1313
}
1414

15-
// Timestamp in nanoseconds.
15+
/// Timestamp in nanoseconds.
1616
type timestamp = u64;
1717

18-
// Error codes returned by functions.
19-
// Not all of these error codes are returned by the functions provided by this
20-
// API/ some are used in higher-level library layers, and others are provided
21-
// merely for alignment with POSIX.
18+
/// Error codes returned by functions.
19+
/// Not all of these error codes are returned by the functions provided by this
20+
/// API/ some are used in higher-level library layers, and others are provided
21+
/// merely for alignment with POSIX.
2222
enum errno {
23-
// No error occurred. System call completed successfully.
23+
/// No error occurred. System call completed successfully.
2424
success,
25-
// Argument list too long.
25+
/// Argument list too long.
2626
toobig,
27-
// Permission denied.
27+
/// Permission denied.
2828
access,
29-
// Address in use.
29+
/// Address in use.
3030
addrinuse,
31-
// Address not available.
31+
/// Address not available.
3232
addrnotavail,
33-
// Address family not supported.
33+
/// Address family not supported.
3434
afnosupport,
35-
// Resource unavailable, or operation would block.
35+
/// Resource unavailable, or operation would block.
3636
again,
37-
// Connection already in progress.
37+
/// Connection already in progress.
3838
already,
39-
// Bad file descriptor.
39+
/// Bad file descriptor.
4040
badf,
41-
// Bad message.
41+
/// Bad message.
4242
badmsg,
43-
// Device or resource busy.
43+
/// Device or resource busy.
4444
busy,
45-
// Operation canceled.
45+
/// Operation canceled.
4646
canceled,
47-
// No child processes.
47+
/// No child processes.
4848
child,
49-
// Connection aborted.
49+
/// Connection aborted.
5050
connaborted,
51-
// Connection refused.
51+
/// Connection refused.
5252
connrefused,
53-
// Connection reset.
53+
/// Connection reset.
5454
connreset,
55-
// Resource deadlock would occur.
55+
/// Resource deadlock would occur.
5656
deadlk,
57-
// Destination address required.
57+
/// Destination address required.
5858
destaddrreq,
59-
// Mathematics argument out of domain of function.
59+
/// Mathematics argument out of domain of function.
6060
dom,
61-
// Reserved.
61+
/// Reserved.
6262
dquot,
63-
// File exists.
63+
/// File exists.
6464
exist,
65-
// Bad address.
65+
/// Bad address.
6666
fault,
67-
// File too large.
67+
/// File too large.
6868
fbig,
69-
// Host is unreachable.
69+
/// Host is unreachable.
7070
hostunreach,
71-
// Identifier removed.
71+
/// Identifier removed.
7272
idrm,
73-
// Illegal byte sequence.
73+
/// Illegal byte sequence.
7474
ilseq,
75-
// Operation in progress.
75+
/// Operation in progress.
7676
inprogress,
77-
// Interrupted function.
77+
/// Interrupted function.
7878
intr,
79-
// Invalid argument.
79+
/// Invalid argument.
8080
inval,
81-
// I/O error.
81+
/// I/O error.
8282
io,
83-
// Socket is connected.
83+
/// Socket is connected.
8484
isconn,
85-
// Is a directory.
85+
/// Is a directory.
8686
isdir,
87-
// Too many levels of symbolic links.
87+
/// Too many levels of symbolic links.
8888
loop,
89-
// File descriptor value too large.
89+
/// File descriptor value too large.
9090
mfile,
91-
// Too many links.
91+
/// Too many links.
9292
mlink,
93-
// Message too large.
93+
/// Message too large.
9494
msgsize,
95-
// Reserved.
95+
/// Reserved.
9696
multihop,
97-
// Filename too long.
97+
/// Filename too long.
9898
nametoolong,
99-
// Network is down.
99+
/// Network is down.
100100
netdown,
101-
// Connection aborted by network.
101+
/// Connection aborted by network.
102102
netreset,
103-
// Network unreachable.
103+
/// Network unreachable.
104104
netunreach,
105-
// Too many files open in system.
105+
/// Too many files open in system.
106106
nfile,
107-
// No buffer space available.
107+
/// No buffer space available.
108108
nobufs,
109-
// No such device.
109+
/// No such device.
110110
nodev,
111-
// No such file or directory.
111+
/// No such file or directory.
112112
noent,
113-
// Executable file format error.
113+
/// Executable file format error.
114114
noexec,
115-
// No locks available.
115+
/// No locks available.
116116
nolck,
117-
// Reserved.
117+
/// Reserved.
118118
nolink,
119-
// Not enough space.
119+
/// Not enough space.
120120
nomem,
121-
// No message of the desired type.
121+
/// No message of the desired type.
122122
nomsg,
123-
// Protocol not available.
123+
/// Protocol not available.
124124
noprotoopt,
125-
// No space left on device.
125+
/// No space left on device.
126126
nospc,
127-
// Function not supported.
127+
/// Function not supported.
128128
nosys,
129-
// The socket is not connected.
129+
/// The socket is not connected.
130130
notconn,
131-
// Not a directory or a symbolic link to a directory.
131+
/// Not a directory or a symbolic link to a directory.
132132
notdir,
133-
// Directory not empty.
133+
/// Directory not empty.
134134
notempty,
135-
// State not recoverable.
135+
/// State not recoverable.
136136
notrecoverable,
137-
// Not a socket.
137+
/// Not a socket.
138138
notsock,
139-
// Not supported, or operation not supported on socket.
139+
/// Not supported, or operation not supported on socket.
140140
notsup,
141-
// Inappropriate I/O control operation.
141+
/// Inappropriate I/O control operation.
142142
notty,
143-
// No such device or address.
143+
/// No such device or address.
144144
nxio,
145-
// Value too large to be stored in data type.
145+
/// Value too large to be stored in data type.
146146
overflow,
147-
// Previous owner died.
147+
/// Previous owner died.
148148
ownerdead,
149-
// Operation not permitted.
149+
/// Operation not permitted.
150150
perm,
151-
// Broken pipe.
151+
/// Broken pipe.
152152
pipe,
153-
// Protocol error.
153+
/// Protocol error.
154154
proto,
155-
// Protocol not supported.
155+
/// Protocol not supported.
156156
protonosupport,
157-
// Protocol wrong type for socket.
157+
/// Protocol wrong type for socket.
158158
prototype,
159-
// Result too large.
159+
/// Result too large.
160160
range,
161-
// Read-only file system.
161+
/// Read-only file system.
162162
rofs,
163-
// Invalid seek.
163+
/// Invalid seek.
164164
spipe,
165-
// No such process.
165+
/// No such process.
166166
srch,
167-
// Reserved.
167+
/// Reserved.
168168
stale,
169-
// Connection timed out.
169+
/// Connection timed out.
170170
timedout,
171-
// Text file busy.
171+
/// Text file busy.
172172
txtbsy,
173-
// Cross-device link.
173+
/// Cross-device link.
174174
xdev,
175-
// Extension: Capabilities insufficient.
175+
/// Extension: Capabilities insufficient.
176176
notcapable,
177177
}
178178
}

0 commit comments

Comments
 (0)