| author |  matt ettler <mattettler@protonmail.com> 2024-07-28 18:43:04-06:00 |
| committer |  Andrew Kelley <andrew@ziglang.org> 2024-07-28 21:34:14-07:00 |
| log | ed7f11ffa75877896a2723505589499866864e50 |
| tree | f41bf3bb3a5e26f054ecb477abb21d63a929089e |
| parent | 00d6ea4764a6b22ad84be49cb3287de387c38be4 |
chore: correct non-standard comments.
Comments throughout the codebase start with a space.
This commit corrects comments that do not adhere to this
norm.4 files changed, 29 insertions(+), 29 deletions(-)
lib- std
- c.zig
- meta.zig
- os
- uefi
- protocol
- packed_int_array.zig
lib/std/c.zig+21-21
| ... | @@ -733,46 +733,46 @@ pub const F = switch (native_os) { | ... | @@ -733,46 +733,46 @@ pub const F = switch (native_os) { |
| 733 | /// used in conjunction with F.NOCACHE to indicate that DIRECT, synchronous writes | 733 | /// used in conjunction with F.NOCACHE to indicate that DIRECT, synchronous writes |
| 734 | /// should not be used (i.e. its ok to temporarily create cached pages) | 734 | /// should not be used (i.e. its ok to temporarily create cached pages) |
| 735 | pub const NODIRECT = 62; | 735 | 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 |
| 737 | pub const GETPROTECTIONCLASS = 63; | 737 | 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 |
| 739 | pub const SETPROTECTIONCLASS = 64; | 739 | pub const SETPROTECTIONCLASS = 64; |
| 740 | ///file offset to device offset, extended | 740 | /// file offset to device offset, extended |
| 741 | pub const LOG2PHYS_EXT = 65; | 741 | pub const LOG2PHYS_EXT = 65; |
| 742 | ///get record locking information, per-process | 742 | /// get record locking information, per-process |
| 743 | pub const GETLKPID = 66; | 743 | 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 |
| 745 | pub const SETBACKINGSTORE = 70; | 745 | 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 |
| 747 | pub const GETPATH_MTMINFO = 71; | 747 | 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 |
| 749 | pub const GETCODEDIR = 72; | 749 | pub const GETCODEDIR = 72; |
| 750 | ///No SIGPIPE generated on EPIPE | 750 | /// No SIGPIPE generated on EPIPE |
| 751 | pub const SETNOSIGPIPE = 73; | 751 | pub const SETNOSIGPIPE = 73; |
| 752 | ///Status of SIGPIPE for this fd | 752 | /// Status of SIGPIPE for this fd |
| 753 | pub const GETNOSIGPIPE = 74; | 753 | 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 |
| 755 | pub const TRANSCODEKEY = 75; | 755 | pub const TRANSCODEKEY = 75; |
| 756 | ///file being written to a by single writer... if throttling enabled, writes | 756 | /// file being written to a by single writer... if throttling enabled, writes |
| 757 | ///may be broken into smaller chunks with throttling in between | 757 | /// may be broken into smaller chunks with throttling in between |
| 758 | pub const SINGLE_WRITER = 76; | 758 | pub const SINGLE_WRITER = 76; |
| 759 | ///Get the protection version number for this filesystem | 759 | /// Get the protection version number for this filesystem |
| 760 | pub const GETPROTECTIONLEVEL = 77; | 760 | 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) |
| 762 | pub const FINDSIGS = 78; | 762 | 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) |
| 764 | pub const ADDFILESIGS_FOR_DYLD_SIM = 83; | 764 | pub const ADDFILESIGS_FOR_DYLD_SIM = 83; |
| 765 | ///fsync + issue barrier to drive | 765 | /// fsync + issue barrier to drive |
| 766 | pub const BARRIERFSYNC = 85; | 766 | 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 |
| 768 | pub const ADDFILESIGS_RETURN = 97; | 768 | 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 |
| 770 | pub const CHECK_LV = 98; | 770 | pub const CHECK_LV = 98; |
| 771 | ///Deallocate a range of the file | 771 | /// Deallocate a range of the file |
| 772 | pub const PUNCHHOLE = 99; | 772 | pub const PUNCHHOLE = 99; |
| 773 | ///Trim an active file | 773 | /// Trim an active file |
| 774 | pub const TRIM_ACTIVE_FILE = 100; | 774 | pub const TRIM_ACTIVE_FILE = 100; |
| 775 | ///mark the dup with FD_CLOEXEC | 775 | /// mark the dup with FD_CLOEXEC |
| 776 | pub const DUPFD_CLOEXEC = 67; | 776 | pub const DUPFD_CLOEXEC = 67; |
| 777 | /// shared or read lock | 777 | /// shared or read lock |
| 778 | pub const RDLCK = 1; | 778 | pub const RDLCK = 1; |
lib/std/meta.zig+1-1
| ... | @@ -681,7 +681,7 @@ test Tag { | ... | @@ -681,7 +681,7 @@ test Tag { |
| 681 | try testing.expect(Tag(U) == E); | 681 | try testing.expect(Tag(U) == E); |
| 682 | } | 682 | } |
| 683 | 683 | ||
| 684 | ///Returns the active tag of a tagged union | 684 | /// Returns the active tag of a tagged union |
| 685 | pub fn activeTag(u: anytype) Tag(@TypeOf(u)) { | 685 | pub fn activeTag(u: anytype) Tag(@TypeOf(u)) { |
| 686 | const T = @TypeOf(u); | 686 | const T = @TypeOf(u); |
| 687 | return @as(Tag(T), u); | 687 | return @as(Tag(T), u); |
lib/std/os/uefi/protocol/serial_io.zig+6-6
| ... | @@ -15,32 +15,32 @@ pub const SerialIo = extern struct { | ... | @@ -15,32 +15,32 @@ pub const SerialIo = extern struct { |
| 15 | mode: *Mode, | 15 | mode: *Mode, |
| 16 | device_type_guid: ?*Guid, | 16 | device_type_guid: ?*Guid, |
| 17 | 17 | ||
| 18 | ///Resets the serial device. | 18 | /// Resets the serial device. |
| 19 | pub fn reset(self: *const SerialIo) Status { | 19 | pub fn reset(self: *const SerialIo) Status { |
| 20 | return self._reset(self); | 20 | return self._reset(self); |
| 21 | } | 21 | } |
| 22 | 22 | ||
| 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. |
| 24 | pub fn setAttribute(self: *const SerialIo, baudRate: u64, receiverFifoDepth: u32, timeout: u32, parity: ParityType, dataBits: u8, stopBits: StopBitsType) Status { | 24 | pub fn setAttribute(self: *const SerialIo, baudRate: u64, receiverFifoDepth: u32, timeout: u32, parity: ParityType, dataBits: u8, stopBits: StopBitsType) Status { |
| 25 | return self._set_attribute(self, baudRate, receiverFifoDepth, timeout, parity, dataBits, stopBits); | 25 | return self._set_attribute(self, baudRate, receiverFifoDepth, timeout, parity, dataBits, stopBits); |
| 26 | } | 26 | } |
| 27 | 27 | ||
| 28 | ///Sets the control bits on a serial device. | 28 | /// Sets the control bits on a serial device. |
| 29 | pub fn setControl(self: *const SerialIo, control: u32) Status { | 29 | pub fn setControl(self: *const SerialIo, control: u32) Status { |
| 30 | return self._set_control(self, control); | 30 | return self._set_control(self, control); |
| 31 | } | 31 | } |
| 32 | 32 | ||
| 33 | ///Retrieves the status of the control bits on a serial device. | 33 | /// Retrieves the status of the control bits on a serial device. |
| 34 | pub fn getControl(self: *const SerialIo, control: *u32) Status { | 34 | pub fn getControl(self: *const SerialIo, control: *u32) Status { |
| 35 | return self._get_control(self, control); | 35 | return self._get_control(self, control); |
| 36 | } | 36 | } |
| 37 | 37 | ||
| 38 | ///Writes data to a serial device. | 38 | /// Writes data to a serial device. |
| 39 | pub fn write(self: *const SerialIo, bufferSize: *usize, buffer: *anyopaque) Status { | 39 | pub fn write(self: *const SerialIo, bufferSize: *usize, buffer: *anyopaque) Status { |
| 40 | return self._write(self, bufferSize, buffer); | 40 | return self._write(self, bufferSize, buffer); |
| 41 | } | 41 | } |
| 42 | 42 | ||
| 43 | ///Reads data from a serial device. | 43 | /// Reads data from a serial device. |
| 44 | pub fn read(self: *const SerialIo, bufferSize: *usize, buffer: *anyopaque) Status { | 44 | pub fn read(self: *const SerialIo, bufferSize: *usize, buffer: *anyopaque) Status { |
| 45 | return self._read(self, bufferSize, buffer); | 45 | return self._read(self, bufferSize, buffer); |
| 46 | } | 46 | } |
lib/std/packed_int_array.zig+1-1
| ... | @@ -231,7 +231,7 @@ pub fn PackedIntArrayEndian(comptime Int: type, comptime endian: Endian, comptim | ... | @@ -231,7 +231,7 @@ pub fn PackedIntArrayEndian(comptime Int: type, comptime endian: Endian, comptim |
| 231 | return Io.get(&self.bytes, index, 0); | 231 | return Io.get(&self.bytes, index, 0); |
| 232 | } | 232 | } |
| 233 | 233 | ||
| 234 | ///Copy the value of `int` into the array at `index`. | 234 | /// Copy the value of `int` into the array at `index`. |
| 235 | pub fn set(self: *Self, index: usize, int: Int) void { | 235 | pub fn set(self: *Self, index: usize, int: Int) void { |
| 236 | debug.assert(index < int_count); | 236 | debug.assert(index < int_count); |
| 237 | return Io.set(&self.bytes, index, 0, int); | 237 | return Io.set(&self.bytes, index, 0, int); |