From ec3e2561a8da369f3f6021ade462d8239b671afc Mon Sep 17 00:00:00 2001
From: Wen Liang <liangwen12year@gmail.com>
Date: Tue, 9 Mar 2021 21:24:18 -0500
Subject: [PATCH] libnm/doc: document the type of each LLDP attribute of libnm

Signed-off-by: Wen Liang <liangwen12year@gmail.com>

https://gitlab.freedesktop.org/NetworkManager/NetworkManager/-/merge_requests/777
---
 src/libnm-client-public/nm-device.h | 60 +++++++++++++++++++++++++++++
 1 file changed, 60 insertions(+)

diff --git a/src/libnm-client-public/nm-device.h b/src/libnm-client-public/nm-device.h
index 410f083f76..62baac924a 100644
--- a/src/libnm-client-public/nm-device.h
+++ b/src/libnm-client-public/nm-device.h
@@ -63,6 +63,66 @@ _NM_DEPRECATED_SYNC_WRITABLE_PROPERTY
  */
 typedef struct _NMDeviceClass NMDeviceClass;
 
+/**
+ * NMLldpNeighbor:
+ *
+ * Supported attributes are:
+ *
+ * - #NM_LLDP_ATTR_CHASSIS_ID_TYPE (type: 'u')
+ * - #NM_LLDP_ATTR_CHASSIS_ID (type: 's')
+ * - #NM_LLDP_ATTR_DESTINATION (type: 's')
+ * - #NM_LLDP_ATTR_IEEE_802_1_PPVID (type: 'u'). This attribute only reports the first PPVID
+ *   and therefore it is deprecated in favor of NM_LLDP_ATTR_IEEE_802_1_PPVIDS which reports
+ *   all the PPVID.
+ * - #NM_LLDP_ATTR_IEEE_802_1_PPVID_FLAGS (type: 'u'). This attribute only reports the first PPVID
+ *   and therefore it is deprecated in favor of NM_LLDP_ATTR_IEEE_802_1_PPVIDS which reports
+ *   all the PPVID.
+ * - #NM_LLDP_ATTR_IEEE_802_1_PPVIDS (type: 'aa{sv}')
+ *
+ *   An array of dictionaries where each element has keys:
+ *   - flags (type: 'u')
+ *   - ppvid (type: 'u')
+ * - #NM_LLDP_ATTR_IEEE_802_1_PVID (type: 'u')
+ * - #NM_LLDP_ATTR_IEEE_802_1_VID (type: 'u'). This attribute only reports the first VLAN
+ *   and therefore it is deprecated in favor of NM_LLDP_ATTR_IEEE_802_1_VLANS which reports
+ *   all the VLANs.
+ * - #NM_LLDP_ATTR_IEEE_802_1_VLAN_NAME (type: 's'). This attribute only reports the first VLAN
+ *   and therefore it is deprecated in favor of NM_LLDP_ATTR_IEEE_802_1_VLANS which reports
+ *   all the VLANs.
+ * - #NM_LLDP_ATTR_IEEE_802_1_VLANS (type: 'aa{sv}')
+ *
+ *   An array of dictionaries where each element has keys:
+ *   - name (type: 's')
+ *   - vid (type: 'u')
+ * - #NM_LLDP_ATTR_IEEE_802_3_MAC_PHY_CONF (type: 'a{sv}')
+ *
+ *   Dictionary where each element has keys:
+ *   - autoneg (type: 'u')
+ *   - operational-mau-type (type: 'u')
+ *   - pmd-autoneg-cap (type: 'u')
+ * - #NM_LLDP_ATTR_IEEE_802_3_MAX_FRAME_SIZE (type: 'u')
+ * - #NM_LLDP_ATTR_IEEE_802_3_POWER_VIA_MDI (type: 'a{sv}')
+ *
+ *   Dictionary where each element has keys:
+ *   - mdi-power-support (type: 'u')
+ *   - power-class (type: 'u')
+ *   - pse-power-pair (type: 'u')
+ * - #NM_LLDP_ATTR_MANAGEMENT_ADDRESSES (type: 'aa{sv}')
+ *
+ *   An array of dictionaries where each element has keys:
+ *   - address (type: 'ay')
+ *   - address-subtype (type: 'u')
+ *   - interface-number (type: 'u')
+ *   - interface-number-subtype (type: 'u')
+ *   - object-id (type: 'ay')
+ * - #NM_LLDP_ATTR_PORT_DESCRIPTION (type: 's')
+ * - #NM_LLDP_ATTR_PORT_ID_TYPE (type: 'u')
+ * - #NM_LLDP_ATTR_PORT_ID (type: 's')
+ * - #NM_LLDP_ATTR_RAW (type: 'ay')
+ * - #NM_LLDP_ATTR_SYSTEM_CAPABILITIES (type: 'u')
+ * - #NM_LLDP_ATTR_SYSTEM_DESCRIPTION (type: 's')
+ * - #NM_LLDP_ATTR_SYSTEM_NAME (type: 's')
+ **/
 typedef struct _NMLldpNeighbor NMLldpNeighbor;
 
 GType nm_device_get_type(void);