diff options
| author | gingerBill <gingerBill@users.noreply.github.com> | 2024-09-04 21:37:48 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-09-04 21:37:48 +0100 |
| commit | a4fd0c133e824e349f830cad171d46fc210faab4 (patch) | |
| tree | 8c869bc49609d68c5cd9e4e53a2b2f03b92f6297 /core/sys | |
| parent | ce018b4e6fc21356f5236449d90712fc5d0adc3e (diff) | |
| parent | 288312a8126d71fae26c9d62a8cd342d830e1c5f (diff) | |
Merge pull request #4191 from laytan/improve-package-doc-comments
core: improve package doc comments for the documentation generator
Diffstat (limited to 'core/sys')
| -rw-r--r-- | core/sys/info/doc.odin | 9 | ||||
| -rw-r--r-- | core/sys/llvm/bit_manipulation.odin | 1 | ||||
| -rw-r--r-- | core/sys/llvm/code_generator.odin | 1 | ||||
| -rw-r--r-- | core/sys/llvm/standard_c_library.odin | 1 | ||||
| -rw-r--r-- | core/sys/posix/unistd.odin | 2 |
5 files changed, 12 insertions, 2 deletions
diff --git a/core/sys/info/doc.odin b/core/sys/info/doc.odin index 802cd9c60..b5cd62d81 100644 --- a/core/sys/info/doc.odin +++ b/core/sys/info/doc.odin @@ -2,6 +2,12 @@ Copyright 2022 Jeroen van Rijn <nom@duclavier.com>. Made available under Odin's BSD-3 license. +List of contributors: + Jeroen van Rijn: Initial implementation. + Laytan: ARM and RISC-V CPU feature detection. +*/ + +/* Package `core:sys/info` gathers system information on: Windows, Linux, macOS, FreeBSD & OpenBSD. @@ -11,9 +17,10 @@ and CPU information. On Windows, GPUs will also be enumerated using the registry. CPU feature flags can be tested against `cpu_features`, where applicable, e.g. -`if .aes in si.aes { ... }` +`if .aes in info.cpu_features.? { ... }` Example: + package main import "core:fmt" import si "core:sys/info" diff --git a/core/sys/llvm/bit_manipulation.odin b/core/sys/llvm/bit_manipulation.odin index 39464773d..2e237dd32 100644 --- a/core/sys/llvm/bit_manipulation.odin +++ b/core/sys/llvm/bit_manipulation.odin @@ -1,4 +1,5 @@ // Bit Manipulation Intrinsics + package sys_llvm /* diff --git a/core/sys/llvm/code_generator.odin b/core/sys/llvm/code_generator.odin index 7d41ed67b..6422976c5 100644 --- a/core/sys/llvm/code_generator.odin +++ b/core/sys/llvm/code_generator.odin @@ -1,4 +1,5 @@ // Code Generator Intrinsics + package sys_llvm @(default_calling_convention="none") diff --git a/core/sys/llvm/standard_c_library.odin b/core/sys/llvm/standard_c_library.odin index 108d1268e..1818e8462 100644 --- a/core/sys/llvm/standard_c_library.odin +++ b/core/sys/llvm/standard_c_library.odin @@ -1,4 +1,5 @@ // Standard C Library Intrinsics + package sys_llvm @(default_calling_convention="none") diff --git a/core/sys/posix/unistd.odin b/core/sys/posix/unistd.odin index 6ed9e5d11..15dbb576f 100644 --- a/core/sys/posix/unistd.odin +++ b/core/sys/posix/unistd.odin @@ -112,7 +112,7 @@ foreign lib { Return configuration-defined string values. Its use and purpose are similar to sysconf(), but it is used where string values rather than numeric values are returned. - Returns: 0 (setting errno) if `name` is invalid, need `buf` `len` if buf is `nil`, amount of bytes added to buf otherwise + Returns: 0 (setting errno) if `name` is invalid, need `buf` of `len` bytes if `buf` is `nil`, amount of bytes added to buf otherwise [[ More; https://pubs.opengroup.org/onlinepubs/9699919799/functions/confstr.html ]] */ |