| Message ID | 20240711112228.2140606-6-armbru@redhat.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | qapi: Doc comment cleanups | expand |
On Thu, Jul 11, 2024, 7:22 AM Markus Armbruster <armbru@redhat.com> wrote: > Doc comments are reference documentation for users of QMP. > SpiceQueryMouseMode's doc comment contains a note explaining why it's > not named SpiceMouseMode: spice/enums.h has it already. Irrelevant > for users of QMP; delete the note. > Hmmm, yeah, alright. I feel like this one's sorta borderline but I don't feel strongly enough about it to argue to keep it :) > Signed-off-by: Markus Armbruster <armbru@redhat.com> > Reviewed-by: John Snow <jsnow@redhat.com> --- > qapi/ui.json | 2 -- > 1 file changed, 2 deletions(-) > > diff --git a/qapi/ui.json b/qapi/ui.json > index 5bcccbfc93..df089869a5 100644 > --- a/qapi/ui.json > +++ b/qapi/ui.json > @@ -273,8 +273,6 @@ > # @unknown: No information is available about mouse mode used by the > # spice server. > # > -# .. note:: spice/enums.h has a SpiceMouseMode already, hence the name. > -# > # Since: 1.1 > ## > { 'enum': 'SpiceQueryMouseMode', > -- > 2.45.0 > >
diff --git a/qapi/ui.json b/qapi/ui.json index 5bcccbfc93..df089869a5 100644 --- a/qapi/ui.json +++ b/qapi/ui.json @@ -273,8 +273,6 @@ # @unknown: No information is available about mouse mode used by the # spice server. # -# .. note:: spice/enums.h has a SpiceMouseMode already, hence the name. -# # Since: 1.1 ## { 'enum': 'SpiceQueryMouseMode',
Doc comments are reference documentation for users of QMP. SpiceQueryMouseMode's doc comment contains a note explaining why it's not named SpiceMouseMode: spice/enums.h has it already. Irrelevant for users of QMP; delete the note. Signed-off-by: Markus Armbruster <armbru@redhat.com> --- qapi/ui.json | 2 -- 1 file changed, 2 deletions(-)