Package lines for `core:math` and more.

core/log/log.odin

@@ -1,3 +1,4 @@
+// package log implements the context.Logger interface.
 package log
 
 import "base:runtime"

core/math/big/api.odin

@@ -1,3 +1,5 @@
+package math_big
+
 /*
 	Copyright 2021 Jeroen van Rijn <[email protected]>.
 	Made available under Odin's BSD-3 license.
@@ -5,8 +7,6 @@
 	This file collects public proc maps and their aliases.
 */
 
-
-package math_big
 /*
 
 	=== === === === === === === === === === === === === === === === === === === === === === === ===

core/math/big/common.odin

@@ -1,11 +1,10 @@
+package math_big
+
 /*
 	Copyright 2021 Jeroen van Rijn <[email protected]>.
 	Made available under Odin's BSD-3 license.
 */
 
-
-package math_big
-
 import "base:intrinsics"
 
 /*

core/math/big/doc.odin

@@ -1,6 +1,7 @@
+// package big implements arbitrary precision integers and rationals.
+package math_big
+
 /*
-A BigInt implementation in Odin.
 For the theoretical underpinnings, see Knuth's The Art of Computer Programming, Volume 2, section 4.3.
 The code started out as an idiomatic source port of libTomMath, which is in the public domain, with thanks.
-*/
-package math_big
+*/

core/math/big/helpers.odin

@@ -1,11 +1,10 @@
+package math_big
+
 /*
 	Copyright 2021 Jeroen van Rijn <[email protected]>.
 	Made available under Odin's BSD-3 license.
 */
 
-
-package math_big
-
 import "base:intrinsics"
 import "base:runtime"
 import rnd "core:math/rand"

core/math/big/internal.odin

@@ -1,3 +1,5 @@
+package math_big
+
 /*
 	Copyright 2021 Jeroen van Rijn <[email protected]>.
 	Made available under Odin's BSD-3 license.
@@ -25,8 +27,6 @@
 	TODO: Handle +/- Infinity and NaN.
 */
 
-package math_big
-
 import "base:builtin"
 import "base:intrinsics"
 import "core:mem"

core/math/big/logical.odin

@@ -1,3 +1,5 @@
+package math_big
+
 /*
 	Copyright 2021 Jeroen van Rijn <[email protected]>.
 	Made available under Odin's BSD-3 license.
@@ -9,9 +11,6 @@
 	This file contains logical operations like `and`, `or` and `xor`.
 */
 
-
-package math_big
-
 /*
 	The `and`, `or` and `xor` binops differ in two lines only.
 	We could handle those with a switch, but that adds overhead.

core/math/big/prime.odin

@@ -1,3 +1,5 @@
+package math_big
+
 /*
 	Copyright 2021 Jeroen van Rijn <[email protected]>.
 	Made available under Odin's BSD-3 license.
@@ -9,9 +11,6 @@
 	This file contains prime finding operations.
 */
 
-
-package math_big
-
 /*
 	Determines if an Integer is divisible by one of the _PRIME_TABLE primes.
 	Returns true if it is, false if not. 

core/math/big/private.odin

@@ -1,3 +1,5 @@
+package math_big
+
 /*
 	Copyright 2021 Jeroen van Rijn <[email protected]>.
 	Made available under Odin's BSD-3 license.
@@ -16,9 +18,6 @@
 	These aren't exported for the same reasons.
 */
 
-
-package math_big
-
 import "base:intrinsics"
 import "core:mem"
 

core/math/big/public.odin

@@ -1,3 +1,5 @@
+package math_big
+
 /*
 	Copyright 2021 Jeroen van Rijn <[email protected]>.
 	Made available under Odin's BSD-3 license.
@@ -9,9 +11,6 @@
 	This file contains basic arithmetic operations like `add`, `sub`, `mul`, `div`, ...
 */
 
-
-package math_big
-
 import "base:intrinsics"
 
 /*

core/math/big/radix.odin

@@ -1,3 +1,5 @@
+package math_big
+
 /*
 	Copyright 2021 Jeroen van Rijn <[email protected]>.
 	Made available under Odin's BSD-3 license.
@@ -13,9 +15,6 @@
 		- Also look at extracting and splatting several digits at once.
 */
 
-
-package math_big
-
 import "base:intrinsics"
 import "core:mem"
 import "core:os"

core/math/big/tune.odin

@@ -1,3 +1,6 @@
+#+build ignore
+package math_big
+
 /*
 	Copyright 2021 Jeroen van Rijn <[email protected]>.
 	Made available under Odin's BSD-3 license.
@@ -7,9 +10,6 @@
 	The code started out as an idiomatic source port of libTomMath, which is in the public domain, with thanks.
 */
 
-#+build ignore
-package math_big
-
 import "core:time"
 import "base:runtime"
 

core/math/bits/bits.odin

@@ -1,3 +1,4 @@
+// package bits implements bit-level operations, including the ability to set or toggle individual bits in an integer.
 package math_bits
 
 import "base:intrinsics"

core/math/cmplx/cmplx.odin

@@ -1,3 +1,4 @@
+// package cmplx implements trigonometric and other mathematic operations on complex numbers.
 package math_cmplx
 
 import "base:builtin"

core/math/ease/ease.odin

@@ -1,4 +1,4 @@
-// easing procedures and flux easing used for animations
+// package ease implements easing procedures and flux easing used for animations.
 package ease
 
 import "core:math"

core/math/fixed/fixed.odin

@@ -1,3 +1,4 @@
+// package fixed implements fixed-point rational numbers and conversion to/from `f64`.
 package math_fixed
 
 import "core:math"

core/math/linalg/doc.odin

@@ -1,2 +1,2 @@
-// core:math/linalg implements linear algebra procedures useful for 3D spatial transformations
+// package linalg implements linear algebra procedures useful for 3D spatial transformations.
 package linalg

core/math/linalg/glsl/linalg_glsl.odin

@@ -1,4 +1,4 @@
-// core:math/linalg/glsl implements a GLSL-like mathematics library plus numerous other utility procedures
+// package glsl implements a GLSL-like mathematics library plus numerous other utility procedures.
 package math_linalg_glsl
 
 import "base:builtin"

core/math/linalg/hlsl/linalg_hlsl.odin

@@ -1,4 +1,4 @@
-// core:math/linalg/hlsl implements a HLSL-like mathematics library plus numerous other utility procedures
+// package hlsl implements a HLSL-like mathematics library plus numerous other utility procedures.
 package math_linalg_hlsl
 
 import "base:builtin"

core/math/math.odin

@@ -1,3 +1,4 @@
+// package math implements typical trignometric and other basic math routines.
 package math
 
 import "base:intrinsics"

core/math/noise/internal.odin

@@ -1,11 +1,12 @@
+#+private
+package math_noise
+
 /*
 	OpenSimplex2 noise implementation.
 
 	Ported from https://github.com/KdotJPG/OpenSimplex2.
 	Copyright 2022 Yuki2 (https://github.com/NoahR02)
 */
-#+private
-package math_noise
 
 /*
 	Private implementation details follow.

core/math/noise/opensimplex2.odin

@@ -1,5 +1,5 @@
 /*
-	OpenSimplex2 noise implementation.
+	package noise implements the OpenSimplex2 noise algorithm.
 
 	Ported from [[ https://github.com/KdotJPG/OpenSimplex2 }].
 	Copyright 2022 Yuki2 [[ https://github.com/NoahR02 ]]

core/math/rand/rand.odin

@@ -1,7 +1,4 @@
-
-/*
-Package core:math/rand implements various random number generators
-*/
+// package rand implements various random number generators.
 package rand
 
 import "base:intrinsics"