aboutsummaryrefslogtreecommitdiffstats
path: root/man3/MAX.3libsimple
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2018-11-07 22:18:04 +0100
committerMattias Andrée <maandree@kth.se>2018-11-07 22:18:04 +0100
commit9fc2b129167e1f2a16d942369f057f618a00d81c (patch)
treec15d15d8afc525a423ce0d43d95f676e6e5a2541 /man3/MAX.3libsimple
parentAdd arrayalloc man page (diff)
downloadlibsimple-9fc2b129167e1f2a16d942369f057f618a00d81c.tar.gz
libsimple-9fc2b129167e1f2a16d942369f057f618a00d81c.tar.bz2
libsimple-9fc2b129167e1f2a16d942369f057f618a00d81c.tar.xz
Move section 3 man pages to man3/ and add libsimple.h.0
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'man3/MAX.3libsimple')
-rw-r--r--man3/MAX.3libsimple58
1 files changed, 58 insertions, 0 deletions
diff --git a/man3/MAX.3libsimple b/man3/MAX.3libsimple
new file mode 100644
index 0000000..e4a4d62
--- /dev/null
+++ b/man3/MAX.3libsimple
@@ -0,0 +1,58 @@
+.TH MAX 3 2018-11-05 libsimple
+.SH NAME
+MAX \- get the greater of two values
+.SH SYNOPSIS
+.nf
+#include <libsimple.h>
+
+#ifndef MAX
+# define MAX(a, b) /* implementation omitted */
+#endif
+.fi
+.SH DESCRIPTION
+The
+.BR MAX ()
+macro is a function-like macro that
+returns the greater of the values
+.I a
+and
+.IR b .
+.PP
+The
+.I a
+and
+.I b
+expressions must not have side-effects.
+.PP
+If both of the
+.I a
+and
+.I b
+parameters are constants expressions, the
+return value is also a constant expression.
+.SH RETURN VALUE
+The
+.BR MAX ()
+macro returns to the greater value.
+.SH ERRORS
+The
+.BR libsimple_close ()
+function fail for the reasons specified for the
+.BR close (3)
+function.
+.SH EXAMPLES
+None.
+.SH APPLICATION USAGE
+None.
+.SH RATIONALE
+None.
+.SH FUTURE DIRECTIONS
+None.
+.SH NOTES
+None.
+.SH BUGS
+None.
+.SH SEE ALSO
+.BR MIN (3libsimple),
+.BR MIN3 (3libsimple),
+.BR MAX3 (3libsimple)