diff --git a/doc/dbus.doxygen b/doc/dbus.doxygen new file mode 100644 index 000000000..88d2cf4e9 --- /dev/null +++ b/doc/dbus.doxygen @@ -0,0 +1,656 @@ +/** +\page dbus %wpa_supplicant D-Bus API + +This section documents the %wpa_supplicant D-Bus API. Every D-Bus +interface implemented by %wpa_supplicant is described here including +their methods, signals, and properties with arguments, returned +values, and possible errors. + +Interfaces: +- \ref dbus_main +- \ref dbus_interface +- \ref dbus_wps +- \ref dbus_bss +- \ref dbus_network + + +\section dbus_main fi.w1.wpa_supplicant1 + +Interface implemented by the main %wpa_supplicant D-Bus object +registered in the bus with fi.w1.wpa_supplicant1 name. + +\subsection dbus_main_methods Methods + + + +\subsection dbus_main_properties Properties + + + +\subsection dbus_main_signals Signals + + + + +\section dbus_interface fi.w1.wpa_supplicant1.Interface + +Interface implemented by objects related to network interface added to +%wpa_supplicant, i.e., returned by +fi.w1.wpa_supplicant1.CreateInterface. + +\subsection dbus_interface_methods Methods + + + +\subsection dbus_interface_properties Properties + + + +\subsection dbus_interface_signals Signals + + + + +\section dbus_wps fi.w1.wpa_supplicant1.Interface.WPS + +Interface implemented by objects related to network interface added to +&wpa_supplicant, i.e., returned by fi.w1.wpa_supplicant1.CreateInterface. + +\subsection dbus_wps_methods Methods + + + +\subsection dbus_wps_properties Properties + + + +\subsection dbus_wps_signals Signals + + + + +\section dbus_bss fi.w1.wpa_supplicant1.Interface.BSS + +Interface implemented by objects representing a scanned BSSs, i.e., +scan results. + +\subsection dbus_bss_properties Properties + + + + +\section dbus_network fi.w1.wpa_supplicant1.Interface.Network + +Interface implemented by objects representing configured networks, +i.e., returned by fi.w1.wpa_supplicant1.Interface.AddNetwork. + +\subsection dbus_network_properties Properties + + + +\subsection dbus_network_signals Signals + + + +*/