aboutsummaryrefslogtreecommitdiff
path: root/core/sys/info/doc.odin
diff options
context:
space:
mode:
authorLaytan Laats <laytanlaats@hotmail.com>2024-09-03 19:59:04 +0200
committerLaytan Laats <laytanlaats@hotmail.com>2024-09-03 19:59:04 +0200
commit288312a8126d71fae26c9d62a8cd342d830e1c5f (patch)
treeaa56a083e0222975888a24cf8d755b7d0a4f1bc0 /core/sys/info/doc.odin
parent0e6109e171d24b3bb17289219ae3b482c24f2460 (diff)
core: improve package doc comments for the documentation generator
Diffstat (limited to 'core/sys/info/doc.odin')
-rw-r--r--core/sys/info/doc.odin9
1 files changed, 8 insertions, 1 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"