Merge pull request #4191 from laytan/improve-package-doc-comments

core: improve package doc comments for the documentation generator

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"

core/sys/llvm/bit_manipulation.odin

@@ -1,4 +1,5 @@
 // Bit Manipulation Intrinsics
+
 package sys_llvm
 
 /*

core/sys/llvm/code_generator.odin

@@ -1,4 +1,5 @@
 // Code Generator Intrinsics
+
 package sys_llvm
 
 @(default_calling_convention="none")

core/sys/llvm/standard_c_library.odin

@@ -1,4 +1,5 @@
 // Standard C Library Intrinsics
+
 package sys_llvm
 
 @(default_calling_convention="none")

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 ]]
 	*/