fdo-mirrors/NetworkManager
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/NetworkManager/NetworkManager.git synced 2026-04-05 11:20:36 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: document serial setting properties

Browse source
This commit is contained in:
Dan Williams 2009-11-11 14:07:14 -08:00
parent 963dde80a4
commit 9a9e833af6
1 changed files with 41 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

46
libnm-util/nm-setting-serial.c
View file

@ -236,43 +236,79 @@ nm_setting_serial_class_init (NMSettingSerialClass *setting_class)
/* Properties */
/**
* NMSettingSerial:baud:
*
* 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.
**/
g_object_class_install_property
(object_class, PROP_BAUD,
g_param_spec_uint (NM_SETTING_SERIAL_BAUD,
"Baud",
"Baud rate",
"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.",
0, G_MAXUINT, 57600,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_SERIALIZE));
/**
* NMSettingSerial:bits:
*
* Byte-width of the serial communication.
**/
g_object_class_install_property
(object_class, PROP_BITS,
g_param_spec_uint (NM_SETTING_SERIAL_BITS,
"Bits",
"Bits",
"Byte-width of the serial communication. The 8 in "
"'8n1' for example.",
5, 8, 8,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_SERIALIZE));
/**
* NMSettingSerial:parity:
*
* Parity setting of the serial port. Either 'E' for even parity, 'o' for
* odd parity, or 'n' for no parity.
**/
g_object_class_install_property
(object_class, PROP_PARITY,
g_param_spec_char (NM_SETTING_SERIAL_PARITY,
"Parity",
"Parity",
"Parity setting of the serial port. Either 'E' for even "
"parity, 'o' for odd parity, or 'n' for no parity.",
'E', 'o', 'n',
G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_SERIALIZE));
/**
* NMSettingSerial:stopbits:
*
* Number of stop bits for communication on the serial port. Either 1 or 2.
* The 1 in '8n1' for example.
**/
g_object_class_install_property
(object_class, PROP_STOPBITS,
g_param_spec_uint (NM_SETTING_SERIAL_STOPBITS,
"Stopbits",
"Stopbits",
"Number of stop bits for communication on the serial "
"port. Either 1 or 2. The 1 in '8n1' for example.",
1, 2, 1,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_SERIALIZE));
/**
* NMSettingSerial:send-delay:
*
* Time to delay between each byte sent to the modem, in microseconds.
**/
g_object_class_install_property
(object_class, PROP_SEND_DELAY,
g_param_spec_uint64 (NM_SETTING_SERIAL_SEND_DELAY,
"SendDelay",
"Send delay",
"Time to delay between each byte sent to the modem, "
"in microseconds.",
0, G_MAXUINT64, 0,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT | NM_SETTING_PARAM_SERIALIZE));
}