Re: qapi: [RFC] Doc comment convention for @arg: sections

2023-03-24 Thread Peter Maydell
On Fri, 24 Mar 2023 at 12:05, Markus Armbruster wrote: > > Peter Maydell writes: > > > On Thu, 23 Mar 2023 at 14:48, Markus Armbruster wrote: > >> > >> The QAPI schema doc comment language provides special syntax for command > >> and event arguments, struct and union members, alternate

Re: qapi: [RFC] Doc comment convention for @arg: sections

2023-03-24 Thread Markus Armbruster
Peter Maydell writes: > On Thu, 23 Mar 2023 at 14:48, Markus Armbruster wrote: >> >> The QAPI schema doc comment language provides special syntax for command >> and event arguments, struct and union members, alternate branches, >> enumeration values, and features: "sections" starting with

Re: qapi: [RFC] Doc comment convention for @arg: sections

2023-03-24 Thread Markus Armbruster
Peter Maydell writes: > On Fri, 24 Mar 2023 at 12:05, Markus Armbruster wrote: >> >> Peter Maydell writes: >> >> > On Thu, 23 Mar 2023 at 14:48, Markus Armbruster wrote: >> >> >> >> The QAPI schema doc comment language provides special syntax for command >> >> and event arguments, struct and

Re: qapi: [RFC] Doc comment convention for @arg: sections

2023-03-23 Thread Peter Maydell
On Thu, 23 Mar 2023 at 14:48, Markus Armbruster wrote: > > The QAPI schema doc comment language provides special syntax for command > and event arguments, struct and union members, alternate branches, > enumeration values, and features: "sections" starting with @arg:. > > By convention, we format

qapi: [RFC] Doc comment convention for @arg: sections

2023-03-23 Thread Markus Armbruster
The QAPI schema doc comment language provides special syntax for command and event arguments, struct and union members, alternate branches, enumeration values, and features: "sections" starting with @arg:. By convention, we format them like this: # @arg: Lorem ipsum dolor sit amet,