From 7da51e3ed8b0a2fef94b82240def83ab24d5cac8 Mon Sep 17 00:00:00 2001 From: nsfisis Date: Sun, 19 Oct 2025 00:23:57 +0900 Subject: docs: add PHPDoc to public functions --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 36b27b9..321b6a4 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ A PHP library that provides a port of Java's `Math.nextAfter()` family of functi ## Overview -This library implements IEEE 754 floating-point manipulation functions that return the next representable floating-point value in a given direction: +This library implements IEEE 754 floating-point manipulation functions that return the next representable floating-point number in a given direction: - `nextAfter($x, $y)` - Returns the adjacent float in the direction of another value - `nextUp($x)` - Returns the next float toward positive infinity @@ -61,7 +61,7 @@ Returns the floating-point number adjacent to `$x` in the direction of `$y`. If ### `nextUp(float $x): float` -Returns the floating-point value adjacent to `$x` in the direction of positive infinity. +Returns the floating-point number adjacent to `$x` in the direction of positive infinity. This is semantically equivalent to `nextAfter($x, INF)`. @@ -75,7 +75,7 @@ This is semantically equivalent to `nextAfter($x, INF)`. ### `nextDown(float $x): float` -Returns the floating-point value adjacent to `$x` in the direction of negative infinity. +Returns the floating-point number adjacent to `$x` in the direction of negative infinity. This is semantically equivalent to `nextAfter($x, -INF)`. -- cgit v1.2.3-70-g09d2