introspection: use @since

gdbus-codegen provides a way to specify a version number on various
elements. Use it to instead of a plain text paragraph.
This commit is contained in:
Lubomir Rintel 2022-03-18 14:41:57 +01:00
parent f6ec6ef364
commit 1358831d03
12 changed files with 21 additions and 70 deletions

View file

@ -93,10 +93,10 @@
StateChanged:
@state: (<link linkend="NMActiveConnectionState">NMActiveConnectionState</link>) The new state of the active connection.
@reason: (<link linkend="NMActiveConnectionStateReason">NMActiveConnectionStateReason</link>) Reason code describing the change to the new state.
@since: 1.8
Emitted when the state of the active connection has changed.
Since: 1.8
-->
<signal name="StateChanged">
<arg name="state" type="u"/>

View file

@ -30,31 +30,31 @@
<!--
DeviceId:
@since: 1.20
An identifier used by the modem backend (ModemManager) that aims to
uniquely identify the a device. Can be used to match a connection to a
particular device.
Since: 1.20
-->
<property name="DeviceId" type="s" access="read" />
<!--
OperatorCode:
@since: 1.20
The MCC and MNC (concatenated) of the network the modem is connected to.
Blank if disconnected or not a 3GPP modem.
Since: 1.20
-->
<property name="OperatorCode" type="s" access="read" />
<!--
Apn:
@since: 1.20
The access point name the modem is connected to. Blank if disconnected.
Since: 1.20
-->
<property name="Apn" type="s" access="read" />

View file

@ -9,12 +9,11 @@
<!--
Slaves:
@since: 1.14
DEPRECATED. Use the "Ports" property in
"org.freedesktop.NetworkManager.Device" instead which exists since
version NetworkManager 1.34.0.
Since: 1.14
-->
<property name="Slaves" type="ao" access="read"/>

View file

@ -9,12 +9,11 @@
<!--
Slaves:
@since: 1.14
DEPRECATED. Use the "Ports" property in
"org.freedesktop.NetworkManager.Device" instead which exists since
version NetworkManager 1.34.0.
Since: 1.14
-->
<property name="Slaves" type="ao" access="read"/>

View file

@ -3,8 +3,7 @@
<!--
org.freedesktop.NetworkManager.Device.WifiP2P:
@short_description: Wi-Fi P2P Device
Since: 1.16
@since: 1.16
-->
<interface name="org.freedesktop.NetworkManager.Device.WifiP2P">
<annotation name="org.gtk.GDBus.C.Name" value="Device_Wifi_P2P"/>
@ -15,8 +14,6 @@
The active hardware address of the device.
DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0.
Since: 1.16
-->
<property name="HwAddress" type="s" access="read"/>
@ -24,8 +21,6 @@
Peers:
List of object paths of peers visible to this Wi-Fi P2P device.
Since: 1.16
-->
<property name="Peers" type="ao" access="read"/>
@ -36,8 +31,6 @@
30 seconds.
Start a find operation for Wi-Fi P2P peers.
Since: 1.16
-->
<method name="StartFind">
<arg name="options" type="a{sv}" direction="in"/>
@ -47,8 +40,6 @@
StopFind:
Stop an ongoing find operation again.
Since: 1.16
-->
<method name="StopFind">
</method>
@ -58,8 +49,6 @@
@peer: The object path of the newly found access point.
Emitted when a new Wi-Fi P2P peer is found by the device.
Since: 1.16
-->
<signal name="PeerAdded">
<arg name="peer" type="o"/>
@ -70,8 +59,6 @@
@peer: The object path of the Wi-Fi P2P peer that has disappeared.
Emitted when a Wi-Fi P2P peer disappears from view of the device.
Since: 1.16
-->
<signal name="PeerRemoved">
<arg name="peer" type="o"/>

View file

@ -100,11 +100,10 @@
<!--
LastScan:
@since: 1.12
The timestamp (in CLOCK_BOOTTIME milliseconds) for the last finished network scan.
A value of -1 means the device never scanned for access points.
Since: 1.12
-->
<property name="LastScan" type="x" access="read"/>

View file

@ -268,58 +268,53 @@
<!--
Ip4Connectivity:
@since: 1.16
The result of the last IPv4 connectivity check.
Since: 1.16
Returns: <link linkend="NMConnectivityState">NMConnectivityState</link>
-->
<property name="Ip4Connectivity" type="u" access="read"/>
<!--
Ip6Connectivity:
@since: 1.16
The result of the last IPv6 connectivity check.
Since: 1.16
Returns: <link linkend="NMConnectivityState">NMConnectivityState</link>
-->
<property name="Ip6Connectivity" type="u" access="read"/>
<!--
InterfaceFlags:
@since: 1.22
The flags of the network interface. See
<link linkend="NMDeviceInterfaceFlags">NMDeviceInterfaceFlags</link> for
the currently defined flags.
Since: 1.22
-->
<property name="InterfaceFlags" type="u" access="read"/>
<!--
HwAddress:
@since: 1.24
The hardware address of the device.
This replaces the other 'HwAddress' properties on the device-specific D-Bus interfaces.
Since: 1.24
-->
<property name="HwAddress" type="s" access="read"/>
<!--
Ports:
@since: 1.34
The port devices of the controller device.
Array of object paths representing devices which are currently set as
port of this device. This replaces the 'Slaves' properties on the
device-specific D-Bus interfaces.
Since: 1.34
-->
<property name="Ports" type="ao" access="read"/>

View file

@ -61,11 +61,10 @@
<!--
NameserverData:
@since: 1.14
The nameservers in use. Currently, only the value "address"
is recognized (with an IP address string).
Since: 1.14
-->
<property name="NameserverData" type="aa{sv}" access="read"/>
@ -108,10 +107,9 @@
<!--
WinsServerData:
@since: 1.14
The Windows Internet Name Service servers associated with the connection.
Since: 1.14
-->
<property name="WinsServerData" type="as" access="read"/>

View file

@ -118,6 +118,7 @@
arguments are accepted. Specifying unknown keys causes the call
to fail.
@result: output argument, currently no results are returned.
@since: 1.12
Update the connection with new settings and properties (replacing all
previous settings and properties). If the flag 0x1 is present,
@ -136,8 +137,6 @@
associated with each secret.
Update2 is a extensible alternative to Update, UpdateUnsaved and Save.
Since: 1.12
-->
<method name="Update2">
<arg name="settings" type="a{sa{sv}}" direction="in"/>
@ -168,21 +167,19 @@
<!--
Flags:
@since: 1.12
Additional flags of the connection profile.
Returns: <link linkend="NMSettingsConnectionFlags">NMSettingsConnectionFlags</link>
Since: 1.12
-->
<property name="Flags" type="u" access="read"/>
<!--
Filename:
@since: 1.12
File that stores the connection in case the connection is file-backed.
Since: 1.12
-->
<property name="Filename" type="s" access="read"/>

View file

@ -76,6 +76,7 @@
to fail.
@path: Object path of the new connection that was just added.
@result: output argument, currently no additional results are returned.
@since: 1.20
Add a new connection profile.
@ -87,8 +88,6 @@
AddConnection2 is a extensible alternative to AddConnection, and AddConnectionUnsaved.
The new variant can do everything that the older variants could, and more.
Since: 1.20
-->
<method name="AddConnection2">
<arg name="settings" type="a{sa{sv}}" direction="in"/>

View file

@ -3,8 +3,7 @@
<!--
org.freedesktop.NetworkManager.WifiP2PPeer:
@short_description: Wi-Fi P2P Peer
Since: 1.16
@since: 1.16
-->
<interface name="org.freedesktop.NetworkManager.WifiP2PPeer">
<annotation name="org.gtk.GDBus.C.Name" value="Wifi_P2P_Peer"/>
@ -18,8 +17,6 @@
Name:
Device name.
Since: 1.16
-->
<property name="Name" type="s" access="read"/>
@ -29,8 +26,6 @@
Flags describing the capabilities of the access point.
Returns: <link linkend="NM80211ApFlags">NM80211ApFlags</link>
Since: 1.16
-->
<property name="Flags" type="u" access="read"/>
@ -38,8 +33,6 @@
Manufacturer:
The manufacturer of the Wi-Fi P2P peer.
Since: 1.16
-->
<property name="Manufacturer" type="s" access="read"/>
@ -47,8 +40,6 @@
Model:
The model of the Wi-Fi P2P peer.
Since: 1.16
-->
<property name="Model" type="s" access="read"/>
@ -56,8 +47,6 @@
ModelNumber:
The model number of the Wi-Fi P2P peer.
Since: 1.16
-->
<property name="ModelNumber" type="s" access="read"/>
@ -65,8 +54,6 @@
Serial:
The serial number of the Wi-Fi P2P peer.
Since: 1.16
-->
<property name="Serial" type="s" access="read"/>
@ -74,8 +61,6 @@
WfdIEs:
The Wi-Fi Display Information Elements of the Wi-Fi P2P peer.
Since: 1.16
-->
<property name="WfdIEs" type="ay" access="read"/>
@ -83,8 +68,6 @@
HwAddress:
The hardware address (BSSID) of the access point.
Since: 1.16
-->
<property name="HwAddress" type="s" access="read"/>
@ -92,8 +75,6 @@
Strength:
The current signal quality of the access point, in percent.
Since: 1.16
-->
<property name="Strength" type="y" access="read"/>
@ -103,8 +84,6 @@
The timestamp (in CLOCK_BOOTTIME seconds) for the last time the access
point was found in scan results. A value of -1 means the access point has
never been found in scan results.
Since: 1.16
-->
<property name="LastSeen" type="i" access="read"/>

View file

@ -296,10 +296,9 @@
will be recalculated to give the approximate new expiration time.
The new "RollbackTimeout" property will be approximate up to
one second precision, which is the accuracy of the property.
@since: 1.12
Reset the timeout for rollback for the checkpoint.
Since: 1.12
-->
<method name="CheckpointAdjustRollbackTimeout">
<arg name="checkpoint" type="o" direction="in"/>