| Message ID | 20240917230020.247073-1-kaidong@chromium.org |
|---|---|
| State | New |
| Headers | show |
| Series | [1/1] Fix the documentation of SignalPoll method | expand |
Hello Jouni, The first patch (https://patchwork.ozlabs.org/project/hostap/patch/20240117210557.2606474-1-kaidong@chromium.org/) for removing the variant wrapping of the properties in SignalPoll was not accepted yet, so I made this patch to update the documentation to reflect the wrapping. Thanks! Best regards Kaidong On Tue, Sep 17, 2024 at 4:00 PM Kaidong Wang <kaidong@chromium.org> wrote: > > Method SignalPoll wraps the dictionary of properties in a variant > container, update the documentation to reflect the wrapping. > > Signed-off-by: Kaidong Wang <kaidong@chromium.org> > --- > doc/dbus.doxygen | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/doc/dbus.doxygen b/doc/dbus.doxygen > index 37a65365f..314f4f99a 100644 > --- a/doc/dbus.doxygen > +++ b/doc/dbus.doxygen > @@ -653,7 +653,7 @@ fi.w1.wpa_supplicant1.CreateInterface. > </li> > <li> > <h3>SignalPoll ( ) --> a{sv} : properties</h3> > - <p>Fetch signal properties for the current connection.</p> > + <p>Fetch signal properties for the current connection. The dictionary of properties is stored within a variant container.</p> > <h4>Returns</h4> > <dl> > <dt>a{sv} : properties</dt> > -- > 2.46.0.662.g92d0881bb0-goog >
diff --git a/doc/dbus.doxygen b/doc/dbus.doxygen index 37a65365f..314f4f99a 100644 --- a/doc/dbus.doxygen +++ b/doc/dbus.doxygen @@ -653,7 +653,7 @@ fi.w1.wpa_supplicant1.CreateInterface. </li> <li> <h3>SignalPoll ( ) --> a{sv} : properties</h3> - <p>Fetch signal properties for the current connection.</p> + <p>Fetch signal properties for the current connection. The dictionary of properties is stored within a variant container.</p> <h4>Returns</h4> <dl> <dt>a{sv} : properties</dt>
Method SignalPoll wraps the dictionary of properties in a variant container, update the documentation to reflect the wrapping. Signed-off-by: Kaidong Wang <kaidong@chromium.org> --- doc/dbus.doxygen | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)