includes: Fix various spelling errors (#270)

docs: fix some spelling errors

Related issue:
https://github.com/WerWolv/ImHex/issues/1139
This commit is contained in:
C3pa
2024-07-10 21:09:15 +02:00
committed by GitHub
parent 4299243e95
commit 5ff783d571
6 changed files with 21 additions and 21 deletions

View File

@@ -56,17 +56,17 @@ namespace auto std::core {
/** /**
Sets the current default endianess. Sets the current default endianness.
Any patterns created following this attribute will be created using the set endianess. Any patterns created following this attribute will be created using the set endianness.
@param endian The new default endianess @param endian The new default endianness
*/ */
fn set_endian(std::mem::Endian endian) { fn set_endian(std::mem::Endian endian) {
builtin::std::core::set_endian(u32(endian)); builtin::std::core::set_endian(u32(endian));
}; };
/** /**
Gets the current default endianess. Gets the current default endianness.
@return The currently set default endianess @return The currently set default endianness
*/ */
fn get_endian() { fn get_endian() {
return builtin::std::core::get_endian(); return builtin::std::core::get_endian();

View File

@@ -29,7 +29,7 @@ namespace auto std::mem {
using Section = u128; using Section = u128;
/** /**
The Endianess of a value The endianness of a value
*/ */
enum Endian : u8 { enum Endian : u8 {
Native = 0, Native = 0,
@@ -126,7 +126,7 @@ namespace auto std::mem {
Reads a unsigned value from the memory Reads a unsigned value from the memory
@param address The address to read from @param address The address to read from
@param size The size of the value to read @param size The size of the value to read
@param [endian] The endianess of the value to read. Defaults to native @param [endian] The endianness of the value to read. Defaults to native
@return The value read @return The value read
*/ */
fn read_unsigned(u128 address, u8 size, Endian endian = Endian::Native) { fn read_unsigned(u128 address, u8 size, Endian endian = Endian::Native) {
@@ -137,7 +137,7 @@ namespace auto std::mem {
Reads a signed value from the memory Reads a signed value from the memory
@param address The address to read from @param address The address to read from
@param size The size of the value to read @param size The size of the value to read
@param [endian] The endianess of the value to read. Defaults to native @param [endian] The endianness of the value to read. Defaults to native
@return The value read @return The value read
*/ */
fn read_signed(u128 address, u8 size, Endian endian = Endian::Native) { fn read_signed(u128 address, u8 size, Endian endian = Endian::Native) {

View File

@@ -4,13 +4,13 @@ import std.io;
import std.mem; import std.mem;
/*! /*!
Libray to interact with strings. Library to interact with strings.
*/ */
namespace auto std::string { namespace auto std::string {
/** /**
Base type for sized strings. Represents a string with its size preceeding it. Base type for sized strings. Represents a string with its size preceding it.
@tparam SizeType The type of the size field. @tparam SizeType The type of the size field.
@tparam DataType The type of the characters. @tparam DataType The type of the characters.
*/ */

View File

@@ -50,7 +50,7 @@ namespace auto std {
}; };
/** /**
Throws an error notifying the developer that the current codepath is not implemented currently. Throws an error notifying the developer that the current code path is not implemented currently.
*/ */
fn unimplemented() { fn unimplemented() {
std::error("Unimplemented code path reached!"); std::error("Unimplemented code path reached!");

View File

@@ -32,7 +32,7 @@ namespace auto type {
} [[format("type::impl::format_nibbles")]]; } [[format("type::impl::format_nibbles")]];
/** /**
Type representing a single Byte. Decodes the byte as it's hexadeicmal value, individual bits and nibbles Type representing a single Byte. Decodes the byte as it's hexadecimal value, individual bits and nibbles
*/ */
union Byte { union Byte {
u8 value; u8 value;

View File

@@ -8,10 +8,10 @@ namespace auto type {
/** /**
Type representing a single path segment. Use the `Path` type instead of using this on its own Type representing a single path segment. Use the `Path` type instead of using this on its own
@tparam Delimeter The delimeter sequence used to separate two path segments @tparam Delimiter The delimiter sequence used to separate two path segments
*/ */
struct PathSegment<auto Delimeter> { struct PathSegment<auto Delimiter> {
char string[while(std::mem::read_string($, std::string::length(Delimeter)) != Delimeter && std::mem::read_unsigned($, 1) != 0x00)]; char string[while(std::mem::read_string($, std::string::length(Delimiter)) != Delimiter && std::mem::read_unsigned($, 1) != 0x00)];
char separator [[hidden]]; char separator [[hidden]];
if (separator == 0x00) { if (separator == 0x00) {
@@ -21,20 +21,20 @@ namespace auto type {
} [[sealed, format("type::impl::format_path_segment")]]; } [[sealed, format("type::impl::format_path_segment")]];
/** /**
A generic type representing a path with an arbitrary delimeter A generic type representing a path with an arbitrary delimiter
@tparam Delimeter The delimeter sequence used to separate two path segments @tparam Delimiter The delimiter sequence used to separate two path segments
*/ */
struct Path<auto Delimeter> { struct Path<auto Delimiter> {
PathSegment<Delimeter> segments[while(true)]; PathSegment<Delimiter> segments[while(true)];
} [[format("type::impl::format_path")]]; } [[format("type::impl::format_path")]];
/** /**
A type representing a Unix path using a '/' forwardslash as delimeter A type representing a Unix path using a '/' forward slash as delimiter
*/ */
using UnixPath = Path<"/">; using UnixPath = Path<"/">;
/** /**
A type representing a DOS path using a '\\' backslash as delimeter A type representing a DOS path using a '\\' backslash as delimiter
*/ */
using DOSPath = Path<"\\">; using DOSPath = Path<"\\">;