From 169e56f2285860b058199c7480083740fc309b9b Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Mon, 16 Nov 2015 16:34:15 +0100 Subject: doc: arg 2 for *div must not be 0 (lest SIGFPE) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- include/inttypes.h | 3 ++- include/stdlib.h | 9 ++++++--- src/inttypes/div.c | 3 ++- src/stdlib/div.c | 9 ++++++--- 4 files changed, 16 insertions(+), 8 deletions(-) diff --git a/include/inttypes.h b/include/inttypes.h index 3bae82a..9463412 100644 --- a/include/inttypes.h +++ b/include/inttypes.h @@ -38,7 +38,8 @@ * both the quotient and the remainder. * * @param numerator The numerator. - * @param denominator The denominator. + * @param denominator The denominator, must not be 0 lest + * the process will be killed by SIGFPE. * @return The quotient in `.quot`, and * the remainder in `.rem`. */ diff --git a/include/stdlib.h b/include/stdlib.h index cfdd0a7..fe0c5f7 100644 --- a/include/stdlib.h +++ b/include/stdlib.h @@ -61,7 +61,8 @@ * both the quotient and the remainder. * * @param numerator The numerator. - * @param denominator The denominator. + * @param denominator The denominator, must not be 0 lest + * the process will be killed by SIGFPE. * @return The quotient in `.quot`, and * the remainder in `.rem`. */ @@ -73,7 +74,8 @@ div_t div(int, int) * both the quotient and the remainder. * * @param numerator The numerator. - * @param denominator The denominator. + * @param denominator The denominator, must not be 0 lest + * the process will be killed by SIGFPE. * @return The quotient in `.quot`, and * the remainder in `.rem`. */ @@ -85,7 +87,8 @@ ldiv_t ldiv(long, long) * both the quotient and the remainder. * * @param numerator The numerator. - * @param denominator The denominator. + * @param denominator The denominator, must not be 0 lest + * the process will be killed by SIGFPE. * @return The quotient in `.quot`, and * the remainder in `.rem`. */ diff --git a/src/inttypes/div.c b/src/inttypes/div.c index e0330ec..95b6410 100644 --- a/src/inttypes/div.c +++ b/src/inttypes/div.c @@ -27,7 +27,8 @@ * both the quotient and the remainder. * * @param numerator The numerator. - * @param denominator The denominator. + * @param denominator The denominator, must not be 0 lest + * the process will be killed by SIGFPE. * @return The quotient in `.quot`, and * the remainder in `.rem`. */ diff --git a/src/stdlib/div.c b/src/stdlib/div.c index fb32d53..47d5877 100644 --- a/src/stdlib/div.c +++ b/src/stdlib/div.c @@ -27,7 +27,8 @@ * both the quotient and the remainder. * * @param numerator The numerator. - * @param denominator The denominator. + * @param denominator The denominator, must not be 0 lest + * the process will be killed by SIGFPE. * @return The quotient in `.quot`, and * the remainder in `.rem`. */ @@ -42,7 +43,8 @@ div_t div(int numerator, int denominator) * both the quotient and the remainder. * * @param numerator The numerator. - * @param denominator The denominator. + * @param denominator The denominator, must not be 0 lest + * the process will be killed by SIGFPE. * @return The quotient in `.quot`, and * the remainder in `.rem`. */ @@ -57,7 +59,8 @@ ldiv_t ldiv(long numerator, long denominator) * both the quotient and the remainder. * * @param numerator The numerator. - * @param denominator The denominator. + * @param denominator The denominator, must not be 0 lest + * the process will be killed by SIGFPE. * @return The quotient in `.quot`, and * the remainder in `.rem`. */ -- cgit v1.2.3-70-g09d2