diff --git a/docs/reference/glib/glib.toml.in b/docs/reference/glib/glib.toml.in index 67df4adbd..0efe8fddc 100644 --- a/docs/reference/glib/glib.toml.in +++ b/docs/reference/glib/glib.toml.in @@ -73,6 +73,7 @@ content_files = [ "spawn.md", "unix.md", "random.md", + "numerical.md", "markup.md", "base64.md", "goption.md", diff --git a/docs/reference/glib/meson.build b/docs/reference/glib/meson.build index f8417c8ba..a02f055b1 100644 --- a/docs/reference/glib/meson.build +++ b/docs/reference/glib/meson.build @@ -162,6 +162,7 @@ expand_content_files = [ 'main-loop.md', 'memory.md', 'memory-slices.md', + 'numerical.md', 'random.md', 'reference-counting.md', 'running.md', diff --git a/docs/reference/glib/numerical.md b/docs/reference/glib/numerical.md new file mode 100644 index 000000000..2e389e9af --- /dev/null +++ b/docs/reference/glib/numerical.md @@ -0,0 +1,35 @@ +Title: Numerical Definitions +SPDX-License-Identifier: LGPL-2.1-or-later +SPDX-FileCopyrightText: 2001 Havoc Pennington +SPDX-FileCopyrightText: 2010 Red Hat, Inc. + +# Numerical Definitions + +GLib offers mathematical constants such as [const@GLib.PI] for the value of pi; +many platforms have these in the C library, but some don’t. The GLib +versions always exist. + +The [type@GLib.FloatIEEE754] and [type@GLib.DoubleIEEE754] unions are used to +access the sign, mantissa and exponent of IEEE floats and doubles. These unions +are defined as appropriate for a given platform. IEEE floats and doubles are +supported (used for storage) by at least Intel, PPC and Sparc. See +[IEEE 754-2008](http://en.wikipedia.org/wiki/IEEE_float) +for more information about IEEE number formats. + +## Floating Point + + * [const@GLib.IEEE754_FLOAT_BIAS] + * [const@GLib.IEEE754_DOUBLE_BIAS] + * [type@GLib.FloatIEEE754] + * [type@GLib.DoubleIEEE754] + +## Numerical Constants + + * [const@GLib.E] + * [const@GLib.LN2] + * [const@GLib.LN10] + * [const@GLib.PI] + * [const@GLib.PI_2] + * [const@GLib.PI_4] + * [const@GLib.SQRT2] + * [const@GLib.LOG_2_BASE_10] diff --git a/glib/docs.c b/glib/docs.c index 22e867097..af10f6c6a 100644 --- a/glib/docs.c +++ b/glib/docs.c @@ -1806,23 +1806,6 @@ */ /* Numerical Definitions {{{1 */ -/** - * SECTION:numerical - * @title: Numerical Definitions - * @short_description: mathematical constants, and floating point decomposition - * - * GLib offers mathematical constants such as %G_PI for the value of pi; - * many platforms have these in the C library, but some don't, the GLib - * versions always exist. - * - * The #GFloatIEEE754 and #GDoubleIEEE754 unions are used to access the - * sign, mantissa and exponent of IEEE floats and doubles. These unions are - * defined as appropriate for a given platform. IEEE floats and doubles are - * supported (used for storage) by at least Intel, PPC and Sparc. See - * [IEEE 754-2008](http://en.wikipedia.org/wiki/IEEE_float) - * for more information about IEEE number formats. - */ - /** * G_IEEE754_FLOAT_BIAS: *