summaryrefslogtreecommitdiff
path: root/docs/libnm-util/html/NMSettingSerial.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/libnm-util/html/NMSettingSerial.html')
-rw-r--r--docs/libnm-util/html/NMSettingSerial.html41
1 files changed, 12 insertions, 29 deletions
diff --git a/docs/libnm-util/html/NMSettingSerial.html b/docs/libnm-util/html/NMSettingSerial.html
index 6e9ede6a4..43c21e9ed 100644
--- a/docs/libnm-util/html/NMSettingSerial.html
+++ b/docs/libnm-util/html/NMSettingSerial.html
@@ -2,13 +2,13 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>libnm-util Reference Manual: NMSettingSerial</title>
+<title>NMSettingSerial: libnm-util Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="libnm-util Reference Manual">
<link rel="up" href="ch01.html" title="libnm-util API Reference">
<link rel="prev" href="NMSettingBluetooth.html" title="NMSettingBluetooth">
<link rel="next" href="NMSettingCdma.html" title="NMSettingCdma">
-<meta name="generator" content="GTK-Doc V1.21 (XML mode)">
+<meta name="generator" content="GTK-Doc V1.24 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@@ -211,7 +211,6 @@ nm_setting_serial_error_quark (<em class="parameter"><code><span class="type">vo
<div class="refsect3">
<a name="id-1.2.9.9.2.5"></a><h4>Returns</h4>
<p> the error quark used for <a class="link" href="NMSettingSerial.html" title="NMSettingSerial"><span class="type">NMSettingSerial</span></a> errors.</p>
-<p></p>
</div>
</div>
<hr>
@@ -249,7 +248,6 @@ nm_setting_serial_get_baud (<em class="parameter"><code><a class="link" href="NM
<div class="refsect3">
<a name="id-1.2.9.9.4.5"></a><h4>Returns</h4>
<p> the <a class="link" href="NMSettingSerial.html#NMSettingSerial--baud" title="The “baud” property"><span class="type">“baud”</span></a> property of the setting</p>
-<p></p>
</div>
</div>
<hr>
@@ -275,7 +273,6 @@ nm_setting_serial_get_bits (<em class="parameter"><code><a class="link" href="NM
<div class="refsect3">
<a name="id-1.2.9.9.5.5"></a><h4>Returns</h4>
<p> the <a class="link" href="NMSettingSerial.html#NMSettingSerial--bits" title="The “bits” property"><span class="type">“bits”</span></a> property of the setting</p>
-<p></p>
</div>
</div>
<hr>
@@ -301,7 +298,6 @@ nm_setting_serial_get_parity (<em class="parameter"><code><a class="link" href="
<div class="refsect3">
<a name="id-1.2.9.9.6.5"></a><h4>Returns</h4>
<p> the <a class="link" href="NMSettingSerial.html#NMSettingSerial--parity" title="The “parity” property"><span class="type">“parity”</span></a> property of the setting</p>
-<p></p>
</div>
</div>
<hr>
@@ -327,7 +323,6 @@ nm_setting_serial_get_stopbits (<em class="parameter"><code><a class="link" href
<div class="refsect3">
<a name="id-1.2.9.9.7.5"></a><h4>Returns</h4>
<p> the <a class="link" href="NMSettingSerial.html#NMSettingSerial--stopbits" title="The “stopbits” property"><span class="type">“stopbits”</span></a> property of the setting</p>
-<p></p>
</div>
</div>
<hr>
@@ -353,7 +348,6 @@ nm_setting_serial_get_send_delay (<em class="parameter"><code><a class="link" hr
<div class="refsect3">
<a name="id-1.2.9.9.8.5"></a><h4>Returns</h4>
<p> the <a class="link" href="NMSettingSerial.html#NMSettingSerial--send-delay" title="The “send-delay” property"><span class="type">“send-delay”</span></a> property of the setting</p>
-<p></p>
</div>
</div>
</div>
@@ -363,8 +357,6 @@ nm_setting_serial_get_send_delay (<em class="parameter"><code><a class="link" hr
<a name="NM-SETTING-SERIAL-SETTING-NAME:CAPS"></a><h3>NM_SETTING_SERIAL_SETTING_NAME</h3>
<pre class="programlisting">#define NM_SETTING_SERIAL_SETTING_NAME "serial"
</pre>
-<p>
-</p>
</div>
<hr>
<div class="refsect2">
@@ -417,48 +409,36 @@ setting requires the connection to contain an <a class="link" href="NMSettingPPP
<a name="NM-SETTING-SERIAL-ERROR:CAPS"></a><h3>NM_SETTING_SERIAL_ERROR</h3>
<pre class="programlisting">#define NM_SETTING_SERIAL_ERROR nm_setting_serial_error_quark ()
</pre>
-<p>
-</p>
</div>
<hr>
<div class="refsect2">
<a name="NM-SETTING-SERIAL-BAUD:CAPS"></a><h3>NM_SETTING_SERIAL_BAUD</h3>
<pre class="programlisting">#define NM_SETTING_SERIAL_BAUD "baud"
</pre>
-<p>
-</p>
</div>
<hr>
<div class="refsect2">
<a name="NM-SETTING-SERIAL-BITS:CAPS"></a><h3>NM_SETTING_SERIAL_BITS</h3>
<pre class="programlisting">#define NM_SETTING_SERIAL_BITS "bits"
</pre>
-<p>
-</p>
</div>
<hr>
<div class="refsect2">
<a name="NM-SETTING-SERIAL-PARITY:CAPS"></a><h3>NM_SETTING_SERIAL_PARITY</h3>
<pre class="programlisting">#define NM_SETTING_SERIAL_PARITY "parity"
</pre>
-<p>
-</p>
</div>
<hr>
<div class="refsect2">
<a name="NM-SETTING-SERIAL-STOPBITS:CAPS"></a><h3>NM_SETTING_SERIAL_STOPBITS</h3>
<pre class="programlisting">#define NM_SETTING_SERIAL_STOPBITS "stopbits"
</pre>
-<p>
-</p>
</div>
<hr>
<div class="refsect2">
<a name="NM-SETTING-SERIAL-SEND-DELAY:CAPS"></a><h3>NM_SETTING_SERIAL_SEND_DELAY</h3>
<pre class="programlisting">#define NM_SETTING_SERIAL_SEND_DELAY "send-delay"
</pre>
-<p>
-</p>
</div>
</div>
<div class="refsect1">
@@ -466,7 +446,9 @@ setting requires the connection to contain an <a class="link" href="NMSettingPPP
<div class="refsect2">
<a name="NMSettingSerial--baud"></a><h3>The <code class="literal">“baud”</code> property</h3>
<pre class="programlisting"> “baud” <span class="type">guint</span></pre>
-<p></p>
+<p>Speed to use for communication over the serial port. Note that this
+value usually has no effect for mobile broadband modems as they generally
+ignore speed settings and use the highest available speed.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: 57600</p>
</div>
@@ -474,7 +456,7 @@ setting requires the connection to contain an <a class="link" href="NMSettingPPP
<div class="refsect2">
<a name="NMSettingSerial--bits"></a><h3>The <code class="literal">“bits”</code> property</h3>
<pre class="programlisting"> “bits” <span class="type">guint</span></pre>
-<p></p>
+<p>Byte-width of the serial communication. The 8 in "8n1" for example.</p>
<p>Flags: Read / Write / Construct</p>
<p>Allowed values: [5,8]</p>
<p>Default value: 8</p>
@@ -483,7 +465,8 @@ setting requires the connection to contain an <a class="link" href="NMSettingPPP
<div class="refsect2">
<a name="NMSettingSerial--parity"></a><h3>The <code class="literal">“parity”</code> property</h3>
<pre class="programlisting"> “parity” <span class="type">gchar</span></pre>
-<p></p>
+<p>Parity setting of the serial port. Either 'E' for even parity, 'o' for
+odd parity, or 'n' for no parity.</p>
<p>Flags: Read / Write / Construct</p>
<p>Allowed values: [69,111]</p>
<p>Default value: 110</p>
@@ -492,7 +475,7 @@ setting requires the connection to contain an <a class="link" href="NMSettingPPP
<div class="refsect2">
<a name="NMSettingSerial--send-delay"></a><h3>The <code class="literal">“send-delay”</code> property</h3>
<pre class="programlisting"> “send-delay” <span class="type">guint64</span></pre>
-<p></p>
+<p>Time to delay between each byte sent to the modem, in microseconds.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: 0</p>
</div>
@@ -500,7 +483,8 @@ setting requires the connection to contain an <a class="link" href="NMSettingPPP
<div class="refsect2">
<a name="NMSettingSerial--stopbits"></a><h3>The <code class="literal">“stopbits”</code> property</h3>
<pre class="programlisting"> “stopbits” <span class="type">guint</span></pre>
-<p></p>
+<p>Number of stop bits for communication on the serial port. Either 1 or 2.
+The 1 in "8n1" for example.</p>
<p>Flags: Read / Write / Construct</p>
<p>Allowed values: [1,2]</p>
<p>Default value: 1</p>
@@ -508,7 +492,6 @@ setting requires the connection to contain an <a class="link" href="NMSettingPPP
</div>
</div>
<div class="footer">
-<hr>
- Generated by GTK-Doc V1.21</div>
+<hr>Generated by GTK-Doc V1.24</div>
</body>
</html> \ No newline at end of file