Skip to content

Commit ed7f11f

Browse files
MattEttlerandrewrk
authored andcommitted
chore: correct non-standard comments.
Comments throughout the codebase start with a space. This commit corrects comments that do not adhere to this norm.
1 parent 00d6ea4 commit ed7f11f

File tree

4 files changed

+29
-29
lines changed

4 files changed

+29
-29
lines changed

lib/std/c.zig

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -733,46 +733,46 @@ pub const F = switch (native_os) {
733733
/// used in conjunction with F.NOCACHE to indicate that DIRECT, synchronous writes
734734
/// should not be used (i.e. its ok to temporarily create cached pages)
735735
pub const NODIRECT = 62;
736-
///Get the protection class of a file from the EA, returns int
736+
/// Get the protection class of a file from the EA, returns int
737737
pub const GETPROTECTIONCLASS = 63;
738-
///Set the protection class of a file for the EA, requires int
738+
/// Set the protection class of a file for the EA, requires int
739739
pub const SETPROTECTIONCLASS = 64;
740-
///file offset to device offset, extended
740+
/// file offset to device offset, extended
741741
pub const LOG2PHYS_EXT = 65;
742-
///get record locking information, per-process
742+
/// get record locking information, per-process
743743
pub const GETLKPID = 66;
744-
///Mark the file as being the backing store for another filesystem
744+
/// Mark the file as being the backing store for another filesystem
745745
pub const SETBACKINGSTORE = 70;
746-
///return the full path of the FD, but error in specific mtmd circumstances
746+
/// return the full path of the FD, but error in specific mtmd circumstances
747747
pub const GETPATH_MTMINFO = 71;
748-
///Returns the code directory, with associated hashes, to the caller
748+
/// Returns the code directory, with associated hashes, to the caller
749749
pub const GETCODEDIR = 72;
750-
///No SIGPIPE generated on EPIPE
750+
/// No SIGPIPE generated on EPIPE
751751
pub const SETNOSIGPIPE = 73;
752-
///Status of SIGPIPE for this fd
752+
/// Status of SIGPIPE for this fd
753753
pub const GETNOSIGPIPE = 74;
754-
///For some cases, we need to rewrap the key for AKS/MKB
754+
/// For some cases, we need to rewrap the key for AKS/MKB
755755
pub const TRANSCODEKEY = 75;
756-
///file being written to a by single writer... if throttling enabled, writes
757-
///may be broken into smaller chunks with throttling in between
756+
/// file being written to a by single writer... if throttling enabled, writes
757+
/// may be broken into smaller chunks with throttling in between
758758
pub const SINGLE_WRITER = 76;
759-
///Get the protection version number for this filesystem
759+
/// Get the protection version number for this filesystem
760760
pub const GETPROTECTIONLEVEL = 77;
761-
///Add detached code signatures (used by dyld for shared libs)
761+
/// Add detached code signatures (used by dyld for shared libs)
762762
pub const FINDSIGS = 78;
763-
///Add signature from same file, only if it is signed by Apple (used by dyld for simulator)
763+
/// Add signature from same file, only if it is signed by Apple (used by dyld for simulator)
764764
pub const ADDFILESIGS_FOR_DYLD_SIM = 83;
765-
///fsync + issue barrier to drive
765+
/// fsync + issue barrier to drive
766766
pub const BARRIERFSYNC = 85;
767-
///Add signature from same file, return end offset in structure on success
767+
/// Add signature from same file, return end offset in structure on success
768768
pub const ADDFILESIGS_RETURN = 97;
769-
///Check if Library Validation allows this Mach-O file to be mapped into the calling process
769+
/// Check if Library Validation allows this Mach-O file to be mapped into the calling process
770770
pub const CHECK_LV = 98;
771-
///Deallocate a range of the file
771+
/// Deallocate a range of the file
772772
pub const PUNCHHOLE = 99;
773-
///Trim an active file
773+
/// Trim an active file
774774
pub const TRIM_ACTIVE_FILE = 100;
775-
///mark the dup with FD_CLOEXEC
775+
/// mark the dup with FD_CLOEXEC
776776
pub const DUPFD_CLOEXEC = 67;
777777
/// shared or read lock
778778
pub const RDLCK = 1;

lib/std/meta.zig

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -681,7 +681,7 @@ test Tag {
681681
try testing.expect(Tag(U) == E);
682682
}
683683

684-
///Returns the active tag of a tagged union
684+
/// Returns the active tag of a tagged union
685685
pub fn activeTag(u: anytype) Tag(@TypeOf(u)) {
686686
const T = @TypeOf(u);
687687
return @as(Tag(T), u);

lib/std/os/uefi/protocol/serial_io.zig

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,32 +15,32 @@ pub const SerialIo = extern struct {
1515
mode: *Mode,
1616
device_type_guid: ?*Guid,
1717

18-
///Resets the serial device.
18+
/// Resets the serial device.
1919
pub fn reset(self: *const SerialIo) Status {
2020
return self._reset(self);
2121
}
2222

23-
///Sets the baud rate, receive FIFO depth, transmit/receive time out, parity, data bits, and stop bits on a serial device.
23+
/// Sets the baud rate, receive FIFO depth, transmit/receive time out, parity, data bits, and stop bits on a serial device.
2424
pub fn setAttribute(self: *const SerialIo, baudRate: u64, receiverFifoDepth: u32, timeout: u32, parity: ParityType, dataBits: u8, stopBits: StopBitsType) Status {
2525
return self._set_attribute(self, baudRate, receiverFifoDepth, timeout, parity, dataBits, stopBits);
2626
}
2727

28-
///Sets the control bits on a serial device.
28+
/// Sets the control bits on a serial device.
2929
pub fn setControl(self: *const SerialIo, control: u32) Status {
3030
return self._set_control(self, control);
3131
}
3232

33-
///Retrieves the status of the control bits on a serial device.
33+
/// Retrieves the status of the control bits on a serial device.
3434
pub fn getControl(self: *const SerialIo, control: *u32) Status {
3535
return self._get_control(self, control);
3636
}
3737

38-
///Writes data to a serial device.
38+
/// Writes data to a serial device.
3939
pub fn write(self: *const SerialIo, bufferSize: *usize, buffer: *anyopaque) Status {
4040
return self._write(self, bufferSize, buffer);
4141
}
4242

43-
///Reads data from a serial device.
43+
/// Reads data from a serial device.
4444
pub fn read(self: *const SerialIo, bufferSize: *usize, buffer: *anyopaque) Status {
4545
return self._read(self, bufferSize, buffer);
4646
}

lib/std/packed_int_array.zig

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,7 @@ pub fn PackedIntArrayEndian(comptime Int: type, comptime endian: Endian, comptim
231231
return Io.get(&self.bytes, index, 0);
232232
}
233233

234-
///Copy the value of `int` into the array at `index`.
234+
/// Copy the value of `int` into the array at `index`.
235235
pub fn set(self: *Self, index: usize, int: Int) void {
236236
debug.assert(index < int_count);
237237
return Io.set(&self.bytes, index, 0, int);

0 commit comments

Comments
 (0)