diff mbox series

[v1] doc: Describe Set properties of fi.w1.wpa_supplicant1.Network

Message ID 20200214110200.20410-1-cfamullaconrad@suse.de
State Accepted
Headers show
Series [v1] doc: Describe Set properties of fi.w1.wpa_supplicant1.Network | expand

Commit Message

Clemens Famulla-Conrad Feb. 14, 2020, 11:02 a.m. UTC
The current description of Properties of fi.wq.wpa_supplicant1.Network
only apply when retrieving these.
If you need to use the method=Set, then the types should be in the same
format as with function AddNetwork().

Signed-off-by: Clemens Famulla-Conrad <cfamullaconrad@suse.de>
---
 doc/dbus.doxygen | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Jouni Malinen Feb. 15, 2020, 5:36 p.m. UTC | #1
On Fri, Feb 14, 2020 at 12:02:00PM +0100, Clemens Famulla-Conrad wrote:
> The current description of Properties of fi.wq.wpa_supplicant1.Network
> only apply when retrieving these.
> If you need to use the method=Set, then the types should be in the same
> format as with function AddNetwork().

Thanks, applied.
diff mbox series

Patch

diff --git a/doc/dbus.doxygen b/doc/dbus.doxygen
index 9bca70cb7..b2b4389c9 100644
--- a/doc/dbus.doxygen
+++ b/doc/dbus.doxygen
@@ -2107,7 +2107,7 @@  i.e., returned by fi.w1.wpa_supplicant1.Interface.AddNetwork.
 
       <li>
 	<h3>Properties - a{sv} - (read/write)</h3>
-	<p>Properties of the configured network. Dictionary contains entries from "network" block of wpa_supplicant configuration file. All values are string type, e.g., frequency is "2437", not 2437.
+	<p>Properties of the configured network. Dictionary contains entries from "network" block of wpa_supplicant configuration file. All values are string type, e.g., frequency is "2437", not 2437. When setting the properties, use the same format as for the AddNetwork() function.</p>
       </li>
     </ul>