aboutsummaryrefslogtreecommitdiffstats
path: root/doc/man
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2016-07-20 16:00:03 +0200
committerMattias Andrée <maandree@kth.se>2016-07-20 16:00:03 +0200
commit4b8e94156c9cf48ccbc8aae8f17cc98752823a95 (patch)
tree3929c75e03c78be2f0239cc43ca5841cd1818c34 /doc/man
parentdisconnect param in libcoopgamma_context_destroy.3 (diff)
downloadlibcoopgamma-4b8e94156c9cf48ccbc8aae8f17cc98752823a95.tar.gz
libcoopgamma-4b8e94156c9cf48ccbc8aae8f17cc98752823a95.tar.bz2
libcoopgamma-4b8e94156c9cf48ccbc8aae8f17cc98752823a95.tar.xz
It is good practice to destroy after failed init
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'doc/man')
-rw-r--r--doc/man/libcoopgamma_async_context_initialise.35
-rw-r--r--doc/man/libcoopgamma_context_initialise.35
-rw-r--r--doc/man/libcoopgamma_crtc_info_initialise.35
-rw-r--r--doc/man/libcoopgamma_error_initialise.35
-rw-r--r--doc/man/libcoopgamma_filter_initialise.35
-rw-r--r--doc/man/libcoopgamma_filter_query_initialise.35
-rw-r--r--doc/man/libcoopgamma_filter_table_initialise.35
-rw-r--r--doc/man/libcoopgamma_queried_filter_initialise.35
-rw-r--r--doc/man/libcoopgamma_ramps_initialise.35
9 files changed, 45 insertions, 0 deletions
diff --git a/doc/man/libcoopgamma_async_context_initialise.3 b/doc/man/libcoopgamma_async_context_initialise.3
index ed0cb80..2b35a66 100644
--- a/doc/man/libcoopgamma_async_context_initialise.3
+++ b/doc/man/libcoopgamma_async_context_initialise.3
@@ -15,6 +15,11 @@ The
.BR libcoopgamma_async_context_initialise ()
function initialises
.IR this .
+.P
+On failure,
+.I this
+should be deinitialised using
+.BR libcoopgamma_async_context_destroy (3).
.SH "RETURN VALUES"
The
.BR libcoopgamma_async_context_initialise ()
diff --git a/doc/man/libcoopgamma_context_initialise.3 b/doc/man/libcoopgamma_context_initialise.3
index 73b3f21..a843488 100644
--- a/doc/man/libcoopgamma_context_initialise.3
+++ b/doc/man/libcoopgamma_context_initialise.3
@@ -15,6 +15,11 @@ The
.BR libcoopgamma_context_initialise ()
function initialises
.IR this .
+.P
+On failure,
+.I this
+should be deinitialised using
+.BR libcoopgamma_context_destroy (3).
.SH "RETURN VALUES"
The
.BR libcoopgamma_context_initialise ()
diff --git a/doc/man/libcoopgamma_crtc_info_initialise.3 b/doc/man/libcoopgamma_crtc_info_initialise.3
index eeb714f..f060125 100644
--- a/doc/man/libcoopgamma_crtc_info_initialise.3
+++ b/doc/man/libcoopgamma_crtc_info_initialise.3
@@ -15,6 +15,11 @@ The
.BR libcoopgamma_crtc_info_initialise ()
function initialises
.IR this .
+.P
+On failure,
+.I this
+should be deinitialised using
+.BR libcoopgamma_crtc_info_destroy (3).
.SH "RETURN VALUES"
The
.BR libcoopgamma_crtc_info_initialise ()
diff --git a/doc/man/libcoopgamma_error_initialise.3 b/doc/man/libcoopgamma_error_initialise.3
index 818bb4e..88156d6 100644
--- a/doc/man/libcoopgamma_error_initialise.3
+++ b/doc/man/libcoopgamma_error_initialise.3
@@ -15,6 +15,11 @@ The
.BR libcoopgamma_error_initialise ()
function initialises
.IR this .
+.P
+On failure,
+.I this
+should be deinitialised using
+.BR libcoopgamma_error_destroy (3).
.SH "RETURN VALUES"
The
.BR libcoopgamma_error_initialise ()
diff --git a/doc/man/libcoopgamma_filter_initialise.3 b/doc/man/libcoopgamma_filter_initialise.3
index 0e808ea..4ccc5ee 100644
--- a/doc/man/libcoopgamma_filter_initialise.3
+++ b/doc/man/libcoopgamma_filter_initialise.3
@@ -15,6 +15,11 @@ The
.BR libcoopgamma_filter_initialise ()
function initialises
.IR this .
+.P
+On failure,
+.I this
+should be deinitialised using
+.BR libcoopgamma_filter_destroy (3).
.SH "RETURN VALUES"
The
.BR libcoopgamma_filter_initialise ()
diff --git a/doc/man/libcoopgamma_filter_query_initialise.3 b/doc/man/libcoopgamma_filter_query_initialise.3
index 8c53feb..c3f3b8a 100644
--- a/doc/man/libcoopgamma_filter_query_initialise.3
+++ b/doc/man/libcoopgamma_filter_query_initialise.3
@@ -15,6 +15,11 @@ The
.BR libcoopgamma_filter_query_initialise ()
function initialises
.IR this .
+.P
+On failure,
+.I this
+should be deinitialised using
+.BR libcoopgamma_filter_query_destroy (3).
.SH "RETURN VALUES"
The
.BR libcoopgamma_filter_query_initialise ()
diff --git a/doc/man/libcoopgamma_filter_table_initialise.3 b/doc/man/libcoopgamma_filter_table_initialise.3
index e689106..4b73b09 100644
--- a/doc/man/libcoopgamma_filter_table_initialise.3
+++ b/doc/man/libcoopgamma_filter_table_initialise.3
@@ -15,6 +15,11 @@ The
.BR libcoopgamma_filter_table_initialise ()
function initialises
.IR this .
+.P
+On failure,
+.I this
+should be deinitialised using
+.BR libcoopgamma_filter_table_destroy (3).
.SH "RETURN VALUES"
The
.BR libcoopgamma_filter_table_initialise ()
diff --git a/doc/man/libcoopgamma_queried_filter_initialise.3 b/doc/man/libcoopgamma_queried_filter_initialise.3
index dd8c309..ac72e5d 100644
--- a/doc/man/libcoopgamma_queried_filter_initialise.3
+++ b/doc/man/libcoopgamma_queried_filter_initialise.3
@@ -15,6 +15,11 @@ The
.BR libcoopgamma_queried_filter_initialise ()
function initialises
.IR this .
+.P
+On failure,
+.I this
+should be deinitialised using
+.BR libcoopgamma_queried_filter_destroy (3).
.SH "RETURN VALUES"
The
.BR libcoopgamma_queried_filter_initialise ()
diff --git a/doc/man/libcoopgamma_ramps_initialise.3 b/doc/man/libcoopgamma_ramps_initialise.3
index 0f33433..69154b5 100644
--- a/doc/man/libcoopgamma_ramps_initialise.3
+++ b/doc/man/libcoopgamma_ramps_initialise.3
@@ -32,6 +32,11 @@ or
The
.BR libcoopgamma_ramps_initialise ()
function is defined as a macro.
+.P
+On failure,
+.I this
+should be deinitialised using
+.BR libcoopgamma_ramps_destroy (3).
.SH "RETURN VALUES"
The
.BR libcoopgamma_ramps_initialise ()