1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Conventions: Buzztrax Bt-Core Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Buzztrax Bt-Core Reference Manual">
<link rel="up" href="pt01.html" title="Part I. Overview">
<link rel="prev" href="pt01.html" title="Part I. Overview">
<link rel="next" href="libbtcore.html" title="API Reference">
<meta name="generator" content="GTK-Doc V1.24.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts"></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="pt01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="pt01.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libbtcore.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="chapter">
<div class="titlepage"><div><div><h2 class="title">
<a name="conventions"></a>Conventions</h2></div></div></div>
<p>
During the API docs some conventions are used to avoid duplication and
improve precision.
</p>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem"><p>
It is never valid to supply <span class="symbol">NULL</span> for an object
reference, unless it is explicitly said so.
</p></li>
<li class="listitem"><p>
Methods do checking of preconditions using <code class="function">g_return_if_fail()</code>
or <code class="function">g_return_val_if_fail()</code>.
Therefore watch for the glib log messages indicating wrong API usage.
</p></li>
<li class="listitem"><p>
All methods that return a pointer to an object, increase the reference counter.
Therefore you should do release this reference by calling <code class="function">g_object_unref()</code>
when you are done with the object.
</p></li>
<li class="listitem"><p>
When a return value is marked as <span class="type">const</span> e.g. <span class="type">const gchar *</span>
or <span class="type">const BtObjectName *</span> then this is a static reference.
You must not call <code class="function">g_free()</code> or <code class="function">g_object_unref()</code>
on it.
</p></li>
</ol></div>
<p>
</p>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24.1</div>
</body>
</html>
|
