From 2bc409eab53bb7208ec59d431112489eb9d226db Mon Sep 17 00:00:00 2001 From: Jeroen van Rijn Date: Thu, 9 Oct 2025 20:40:13 +0200 Subject: [PATCH] More package lines. --- core/path/filepath/path.odin | 4 ++-- core/path/slashpath/path.odin | 3 +-- core/prof/spall/doc.odin | 2 +- core/reflect/doc.odin | 2 +- core/relative/relative.odin | 1 + core/simd/simd.odin | 2 +- core/simd/x86/doc.odin | 2 ++ core/slice/heap/heap.odin | 6 +++--- core/slice/slice.odin | 1 + 9 files changed, 13 insertions(+), 10 deletions(-) create mode 100644 core/simd/x86/doc.odin diff --git a/core/path/filepath/path.odin b/core/path/filepath/path.odin index e23183b02..d23fa1ff1 100644 --- a/core/path/filepath/path.odin +++ b/core/path/filepath/path.odin @@ -1,5 +1,5 @@ -// The path/filepath package uses either forward slashes or backslashes depending on the operating system -// To process paths such as URLs that depend on forward slashes regardless of the OS, use the path package +// package filepath package uses either forward slashes or backslashes depending on the operating system. +// To process paths such as URLs that depend on forward slashes regardless of the OS, use the slashpath package. package filepath import "base:runtime" diff --git a/core/path/slashpath/path.odin b/core/path/slashpath/path.odin index 52b4878bc..5067fa147 100644 --- a/core/path/slashpath/path.odin +++ b/core/path/slashpath/path.odin @@ -1,5 +1,4 @@ -// The slashpath package is only to be used for paths separated by forward slashes, -// e.g. paths in URLs +// package slashpath is only to be used for paths separated by forward slashes, e.g. paths in URLs. // // This package does not deal with Windows/NT paths with volume letters or backslashes // To manipulate operating system specific paths, use the path/filepath package diff --git a/core/prof/spall/doc.odin b/core/prof/spall/doc.odin index be84cac2d..597527b84 100644 --- a/core/prof/spall/doc.odin +++ b/core/prof/spall/doc.odin @@ -1,5 +1,5 @@ /* -package spall is a package that is used for profiling using the "spall" format +package spall is a package that is used for profiling using the "spall" format. Example: package main diff --git a/core/reflect/doc.odin b/core/reflect/doc.odin index 1c94f3dbc..eb8bd7030 100644 --- a/core/reflect/doc.odin +++ b/core/reflect/doc.odin @@ -1,4 +1,4 @@ -// Package reflect provides utility procedures and types to perform runtime type introspection/reflection (RTTI). +// package reflect provides utility procedures and types to perform runtime type introspection/reflection (RTTI). // // WARNING! THIS IS ADVANCED BEHAVIOUR FOR ODIN! THIS SHOULD NOT BE USED BY BEGINNERS TO ODIN! // diff --git a/core/relative/relative.odin b/core/relative/relative.odin index 30a7b86ae..c3e55971b 100644 --- a/core/relative/relative.odin +++ b/core/relative/relative.odin @@ -1,3 +1,4 @@ +// package relative implements relative pointers and slices. package relative_types import "base:intrinsics" diff --git a/core/simd/simd.odin b/core/simd/simd.odin index da76ed49b..3aee09944 100644 --- a/core/simd/simd.odin +++ b/core/simd/simd.odin @@ -1,5 +1,5 @@ /* -The SIMD support package. +package simd implements cross-platform SIMD support types and procedures. SIMD (Single Instruction Multiple Data), is a CPU hardware feature that introduce special registers and instructions which operate on multiple units diff --git a/core/simd/x86/doc.odin b/core/simd/x86/doc.odin new file mode 100644 index 000000000..1a43fa3aa --- /dev/null +++ b/core/simd/x86/doc.odin @@ -0,0 +1,2 @@ +// package x86 implements SIMD intrinsics specific to the Intel x86 and AMD64 architectures. +package simd_x86 \ No newline at end of file diff --git a/core/slice/heap/heap.odin b/core/slice/heap/heap.odin index 7480a1673..f3c016656 100644 --- a/core/slice/heap/heap.odin +++ b/core/slice/heap/heap.odin @@ -1,3 +1,6 @@ +// package heap implements a generic in-place max heap on a slice for any type. +package heap + /* Copyright 2022 Dale Weiler . Made available under Odin's BSD-3 license. @@ -6,9 +9,6 @@ Dale Weiler: Initial implementation */ -// Package implements a generic max heap in-place on a slice for any type. -package heap - /* Constructs a max heap in slice given by data with comparator. A max heap is a range of elements which has the following properties: diff --git a/core/slice/slice.odin b/core/slice/slice.odin index 8337a9728..b103473b7 100644 --- a/core/slice/slice.odin +++ b/core/slice/slice.odin @@ -1,3 +1,4 @@ +// package slice implements utility procedures for working with slices, including sorting and searching them. package slice import "base:intrinsics"