Add libcoopgamma_*_initialise.3, except libcoopgamma_ramps_initialise.3

Signed-off-by: Mattias Andrée <maandree@kth.se>

8 files changed, 312 insertions, 0 deletions

diff --git a/doc/man/libcoopgamma_async_context_initialise.3 b/doc/man/libcoopgamma_async_context_initialise.3
new file mode 100644
index 0000000..4bfbcfc
--- /dev/null
+++ b/doc/man/libcoopgamma_async_context_initialise.3
@@ -0,0 +1,39 @@
+.TH LIBCOOPGAMMA_ASYNC_CONTEXT_INITIALISE 3 LIBCOOPGAMMA
+.SH "NAME"
+libcoopgamma_async_context_initialise - Initialise a libcoopgamma_async_context_t
+.SH "SYNOPSIS"
+.nf
+#include <libcoopgamma.h>
+
+int libcoopgamma_async_context_initialise(libcoopgamma_async_context_t* restrict \fIthis\fP);
+.fi
+.P
+Link with
+.IR -lcoopgamma .
+.SH "DESCRIPTION"
+The
+.BR libcoopgamma_async_context_initialise ()
+function initialises
+.IR this .
+.SH "RETURN VALUES"
+The
+.BR libcoopgamma_async_context_initialise ()
+returns 0 on success. On error, -1 is returned and
+.I errno
+is set appropriately.
+.SH "ERRORS"
+There are no errors specified for the
+.BR libcoopgamma_async_context_initialise ()
+function.
+.SH "SEE ALSO"
+.BR libcoopgamma.h (0),
+.BR libcoopgamma_async_context_destroy (3),
+.BR libcoopgamma_async_context_marshal (3),
+.BR libcoopgamma_ramps_initialise (3),
+.BR libcoopgamma_filter_initialise (3),
+.BR libcoopgamma_crtc_info_initialise (3),
+.BR libcoopgamma_filter_query_initialise (3),
+.BR libcoopgamma_queried_filter_initialise (3),
+.BR libcoopgamma_filter_table_initialise (3),
+.BR libcoopgamma_error_initialise (3),
+.BR libcoopgamma_context_initialise (3)
diff --git a/doc/man/libcoopgamma_context_initialise.3 b/doc/man/libcoopgamma_context_initialise.3
new file mode 100644
index 0000000..5173fed
--- /dev/null
+++ b/doc/man/libcoopgamma_context_initialise.3
@@ -0,0 +1,39 @@
+.TH LIBCOOPGAMMA_CONTEXT_INITIALISE 3 LIBCOOPGAMMA
+.SH "NAME"
+libcoopgamma_context_initialise - Initialise a libcoopgamma_context_t
+.SH "SYNOPSIS"
+.nf
+#include <libcoopgamma.h>
+
+int libcoopgamma_context_initialise(libcoopgamma_context_t* restrict \fIthis\fP);
+.fi
+.P
+Link with
+.IR -lcoopgamma .
+.SH "DESCRIPTION"
+The
+.BR libcoopgamma_context_initialise ()
+function initialises
+.IR this .
+.SH "RETURN VALUES"
+The
+.BR libcoopgamma_context_initialise ()
+returns 0 on success. On error, -1 is returned and
+.I errno
+is set appropriately.
+.SH "ERRORS"
+There are no errors specified for the
+.BR libcoopgamma_context_initialise ()
+function.
+.SH "SEE ALSO"
+.BR libcoopgamma.h (0),
+.BR libcoopgamma_context_destroy (3),
+.BR libcoopgamma_context_marshal (3),
+.BR libcoopgamma_ramps_initialise (3),
+.BR libcoopgamma_filter_initialise (3),
+.BR libcoopgamma_crtc_info_initialise (3),
+.BR libcoopgamma_filter_query_initialise (3),
+.BR libcoopgamma_queried_filter_initialise (3),
+.BR libcoopgamma_filter_table_initialise (3),
+.BR libcoopgamma_error_initialise (3),
+.BR libcoopgamma_async_context_initialise (3)
diff --git a/doc/man/libcoopgamma_crtc_info_initialise.3 b/doc/man/libcoopgamma_crtc_info_initialise.3
new file mode 100644
index 0000000..0203ade
--- /dev/null
+++ b/doc/man/libcoopgamma_crtc_info_initialise.3
@@ -0,0 +1,39 @@
+.TH LIBCOOPGAMMA_CRTC_INFO_INITIALISE 3 LIBCOOPGAMMA
+.SH "NAME"
+libcoopgamma_crtc_info_initialise - Initialise a libcoopgamma_crtc_info_t
+.SH "SYNOPSIS"
+.nf
+#include <libcoopgamma.h>
+
+int libcoopgamma_crtc_info_initialise(libcoopgamma_crtc_info_t* restrict \fIthis\fP);
+.fi
+.P
+Link with
+.IR -lcoopgamma .
+.SH "DESCRIPTION"
+The
+.BR libcoopgamma_crtc_info_initialise ()
+function initialises
+.IR this .
+.SH "RETURN VALUES"
+The
+.BR libcoopgamma_crtc_info_initialise ()
+returns 0 on success. On error, -1 is returned and
+.I errno
+is set appropriately.
+.SH "ERRORS"
+There are no errors specified for the
+.BR libcoopgamma_crtc_info_initialise ()
+function.
+.SH "SEE ALSO"
+.BR libcoopgamma.h (0),
+.BR libcoopgamma_crtc_info_destroy (3),
+.BR libcoopgamma_crtc_info_marshal (3),
+.BR libcoopgamma_ramps_initialise (3),
+.BR libcoopgamma_filter_initialise (3),
+.BR libcoopgamma_filter_query_initialise (3),
+.BR libcoopgamma_queried_filter_initialise (3),
+.BR libcoopgamma_filter_table_initialise (3),
+.BR libcoopgamma_error_initialise (3),
+.BR libcoopgamma_context_initialise (3),
+.BR libcoopgamma_async_context_initialise (3)
diff --git a/doc/man/libcoopgamma_error_initialise.3 b/doc/man/libcoopgamma_error_initialise.3
new file mode 100644
index 0000000..a37ce69
--- /dev/null
+++ b/doc/man/libcoopgamma_error_initialise.3
@@ -0,0 +1,39 @@
+.TH LIBCOOPGAMMA_ERROR_INITIALISE 3 LIBCOOPGAMMA
+.SH "NAME"
+libcoopgamma_error_initialise - Initialise a libcoopgamma_error_t
+.SH "SYNOPSIS"
+.nf
+#include <libcoopgamma.h>
+
+int libcoopgamma_error_initialise(libcoopgamma_error_t* restrict \fIthis\fP);
+.fi
+.P
+Link with
+.IR -lcoopgamma .
+.SH "DESCRIPTION"
+The
+.BR libcoopgamma_error_initialise ()
+function initialises
+.IR this .
+.SH "RETURN VALUES"
+The
+.BR libcoopgamma_error_initialise ()
+returns 0 on success. On error, -1 is returned and
+.I errno
+is set appropriately.
+.SH "ERRORS"
+There are no errors specified for the
+.BR libcoopgamma_error_initialise ()
+function.
+.SH "SEE ALSO"
+.BR libcoopgamma.h (0),
+.BR libcoopgamma_error_destroy (3),
+.BR libcoopgamma_error_marshal (3),
+.BR libcoopgamma_ramps_initialise (3),
+.BR libcoopgamma_filter_initialise (3),
+.BR libcoopgamma_crtc_info_initialise (3),
+.BR libcoopgamma_filter_query_initialise (3),
+.BR libcoopgamma_queried_filter_initialise (3),
+.BR libcoopgamma_filter_table_initialise (3),
+.BR libcoopgamma_context_initialise (3),
+.BR libcoopgamma_async_context_initialise (3)
diff --git a/doc/man/libcoopgamma_filter_initialise.3 b/doc/man/libcoopgamma_filter_initialise.3
new file mode 100644
index 0000000..524b8f9
--- /dev/null
+++ b/doc/man/libcoopgamma_filter_initialise.3
@@ -0,0 +1,39 @@
+.TH LIBCOOPGAMMA_FILTER_INITIALISE 3 LIBCOOPGAMMA
+.SH "NAME"
+libcoopgamma_filter_initialise - Initialise a libcoopgamma_filter_t
+.SH "SYNOPSIS"
+.nf
+#include <libcoopgamma.h>
+
+int libcoopgamma_filter_initialise(libcoopgamma_filter_t* restrict \fIthis\fP);
+.fi
+.P
+Link with
+.IR -lcoopgamma .
+.SH "DESCRIPTION"
+The
+.BR libcoopgamma_filter_initialise ()
+function initialises
+.IR this .
+.SH "RETURN VALUES"
+The
+.BR libcoopgamma_filter_initialise ()
+returns 0 on success. On error, -1 is returned and
+.I errno
+is set appropriately.
+.SH "ERRORS"
+There are no errors specified for the
+.BR libcoopgamma_filter_initialise ()
+function.
+.SH "SEE ALSO"
+.BR libcoopgamma.h (0),
+.BR libcoopgamma_filter_destroy (3),
+.BR libcoopgamma_filter_marshal (3),
+.BR libcoopgamma_ramps_initialise (3),
+.BR libcoopgamma_crtc_info_initialise (3),
+.BR libcoopgamma_filter_query_initialise (3),
+.BR libcoopgamma_queried_filter_initialise (3),
+.BR libcoopgamma_filter_table_initialise (3),
+.BR libcoopgamma_error_initialise (3),
+.BR libcoopgamma_context_initialise (3),
+.BR libcoopgamma_async_context_initialise (3)
diff --git a/doc/man/libcoopgamma_filter_query_initialise.3 b/doc/man/libcoopgamma_filter_query_initialise.3
new file mode 100644
index 0000000..58250d0
--- /dev/null
+++ b/doc/man/libcoopgamma_filter_query_initialise.3
@@ -0,0 +1,39 @@
+.TH LIBCOOPGAMMA_FILTER_QUERY_INITIALISE 3 LIBCOOPGAMMA
+.SH "NAME"
+libcoopgamma_filter_query_initialise - Initialise a libcoopgamma_filter_query_t
+.SH "SYNOPSIS"
+.nf
+#include <libcoopgamma.h>
+
+int libcoopgamma_filter_query_initialise(libcoopgamma_filter_query_t* restrict \fIthis\fP);
+.fi
+.P
+Link with
+.IR -lcoopgamma .
+.SH "DESCRIPTION"
+The
+.BR libcoopgamma_filter_query_initialise ()
+function initialises
+.IR this .
+.SH "RETURN VALUES"
+The
+.BR libcoopgamma_filter_query_initialise ()
+returns 0 on success. On error, -1 is returned and
+.I errno
+is set appropriately.
+.SH "ERRORS"
+There are no errors specified for the
+.BR libcoopgamma_filter_query_initialise ()
+function.
+.SH "SEE ALSO"
+.BR libcoopgamma.h (0),
+.BR libcoopgamma_filter_query_destroy (3),
+.BR libcoopgamma_filter_query_marshal (3),
+.BR libcoopgamma_ramps_initialise (3),
+.BR libcoopgamma_filter_initialise (3),
+.BR libcoopgamma_crtc_info_initialise (3),
+.BR libcoopgamma_queried_filter_initialise (3),
+.BR libcoopgamma_filter_table_initialise (3),
+.BR libcoopgamma_error_initialise (3),
+.BR libcoopgamma_context_initialise (3),
+.BR libcoopgamma_async_context_initialise (3)
diff --git a/doc/man/libcoopgamma_filter_table_initialise.3 b/doc/man/libcoopgamma_filter_table_initialise.3
new file mode 100644
index 0000000..7f25917
--- /dev/null
+++ b/doc/man/libcoopgamma_filter_table_initialise.3
@@ -0,0 +1,39 @@
+.TH LIBCOOPGAMMA_FILTER_TABLE_INITIALISE 3 LIBCOOPGAMMA
+.SH "NAME"
+libcoopgamma_filter_table_initialise - Initialise a libcoopgamma_filter_table_t
+.SH "SYNOPSIS"
+.nf
+#include <libcoopgamma.h>
+
+int libcoopgamma_filter_table_initialise(libcoopgamma_filter_table_t* restrict \fIthis\fP);
+.fi
+.P
+Link with
+.IR -lcoopgamma .
+.SH "DESCRIPTION"
+The
+.BR libcoopgamma_filter_table_initialise ()
+function initialises
+.IR this .
+.SH "RETURN VALUES"
+The
+.BR libcoopgamma_filter_table_initialise ()
+returns 0 on success. On error, -1 is returned and
+.I errno
+is set appropriately.
+.SH "ERRORS"
+There are no errors specified for the
+.BR libcoopgamma_filter_table_initialise ()
+function.
+.SH "SEE ALSO"
+.BR libcoopgamma.h (0),
+.BR libcoopgamma_filter_table_destroy (3),
+.BR libcoopgamma_filter_table_marshal (3),
+.BR libcoopgamma_ramps_initialise (3),
+.BR libcoopgamma_filter_initialise (3),
+.BR libcoopgamma_crtc_info_initialise (3),
+.BR libcoopgamma_filter_query_initialise (3),
+.BR libcoopgamma_queried_filter_initialise (3),
+.BR libcoopgamma_error_initialise (3),
+.BR libcoopgamma_context_initialise (3),
+.BR libcoopgamma_async_context_initialise (3)
diff --git a/doc/man/libcoopgamma_queried_filter_initialise.3 b/doc/man/libcoopgamma_queried_filter_initialise.3
new file mode 100644
index 0000000..5649b73
--- /dev/null
+++ b/doc/man/libcoopgamma_queried_filter_initialise.3
@@ -0,0 +1,39 @@
+.TH LIBCOOPGAMMA_QUERIED_FILTER_INITIALISE 3 LIBCOOPGAMMA
+.SH "NAME"
+libcoopgamma_queried_filter_initialise - Initialise a libcoopgamma_queried_filter_t
+.SH "SYNOPSIS"
+.nf
+#include <libcoopgamma.h>
+
+int libcoopgamma_queried_filter_initialise(libcoopgamma_queried_filter_t* restrict \fIthis\fP);
+.fi
+.P
+Link with
+.IR -lcoopgamma .
+.SH "DESCRIPTION"
+The
+.BR libcoopgamma_queried_filter_initialise ()
+function initialises
+.IR this .
+.SH "RETURN VALUES"
+The
+.BR libcoopgamma_queried_filter_initialise ()
+returns 0 on success. On error, -1 is returned and
+.I errno
+is set appropriately.
+.SH "ERRORS"
+There are no errors specified for the
+.BR libcoopgamma_queried_filter_initialise ()
+function.
+.SH "SEE ALSO"
+.BR libcoopgamma.h (0),
+.BR libcoopgamma_queried_filter_destroy (3),
+.BR libcoopgamma_queried_filter_marshal (3),
+.BR libcoopgamma_ramps_initialise (3),
+.BR libcoopgamma_filter_initialise (3),
+.BR libcoopgamma_crtc_info_initialise (3),
+.BR libcoopgamma_filter_query_initialise (3),
+.BR libcoopgamma_filter_table_initialise (3),
+.BR libcoopgamma_error_initialise (3),
+.BR libcoopgamma_context_initialise (3),
+.BR libcoopgamma_async_context_initialise (3)