Browse Source

More package lines.

Jeroen van Rijn 3 days ago
parent
commit
2bc409eab5

+ 2 - 2
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"

+ 1 - 2
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

+ 1 - 1
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

+ 1 - 1
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!
 //

+ 1 - 0
core/relative/relative.odin

@@ -1,3 +1,4 @@
+// package relative implements relative pointers and slices.
 package relative_types
 
 import "base:intrinsics"

+ 1 - 1
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

+ 2 - 0
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

+ 3 - 3
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 <[email protected]>.
 	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:

+ 1 - 0
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"