| Message ID | 20201003025424.199291-7-ehabkost@redhat.com |
|---|---|
| State | New |
| Headers | show |
| Series | qom documentation fixes | expand |
On 10/3/20 4:54 AM, Eduardo Habkost wrote: > Long code lines don't look good in the rendered documents, make > them shorter. > > Signed-off-by: Eduardo Habkost <ehabkost@redhat.com> Reviewed-by: Philippe Mathieu-Daudé <f4bug@amsat.org> > --- > docs/devel/qom.rst | 9 ++++++--- > 1 file changed, 6 insertions(+), 3 deletions(-) > > diff --git a/docs/devel/qom.rst b/docs/devel/qom.rst > index 0c610e20d62..42d0dc4f4da 100644 > --- a/docs/devel/qom.rst > +++ b/docs/devel/qom.rst > @@ -284,7 +284,8 @@ in the header file: > .. code-block:: c > :caption: Declaring a simple type > > - OBJECT_DECLARE_SIMPLE_TYPE(MyDevice, my_device, MY_DEVICE, DEVICE) > + OBJECT_DECLARE_SIMPLE_TYPE(MyDevice, my_device, > + MY_DEVICE, DEVICE) > > This is equivalent to the following: > > @@ -360,7 +361,8 @@ This accepts an array of interface type names. > > OBJECT_DEFINE_TYPE_WITH_INTERFACES(MyDevice, my_device, > MY_DEVICE, DEVICE, > - { TYPE_USER_CREATABLE }, { NULL }) > + { TYPE_USER_CREATABLE }, > + { NULL }) > > If the type is not intended to be instantiated, then then > the OBJECT_DEFINE_ABSTRACT_TYPE() macro can be used instead: > @@ -368,7 +370,8 @@ the OBJECT_DEFINE_ABSTRACT_TYPE() macro can be used instead: > .. code-block:: c > :caption: Defining a simple abstract type > > - OBJECT_DEFINE_ABSTRACT_TYPE(MyDevice, my_device, MY_DEVICE, DEVICE) > + OBJECT_DEFINE_ABSTRACT_TYPE(MyDevice, my_device, > + MY_DEVICE, DEVICE) > > > >
diff --git a/docs/devel/qom.rst b/docs/devel/qom.rst index 0c610e20d62..42d0dc4f4da 100644 --- a/docs/devel/qom.rst +++ b/docs/devel/qom.rst @@ -284,7 +284,8 @@ in the header file: .. code-block:: c :caption: Declaring a simple type - OBJECT_DECLARE_SIMPLE_TYPE(MyDevice, my_device, MY_DEVICE, DEVICE) + OBJECT_DECLARE_SIMPLE_TYPE(MyDevice, my_device, + MY_DEVICE, DEVICE) This is equivalent to the following: @@ -360,7 +361,8 @@ This accepts an array of interface type names. OBJECT_DEFINE_TYPE_WITH_INTERFACES(MyDevice, my_device, MY_DEVICE, DEVICE, - { TYPE_USER_CREATABLE }, { NULL }) + { TYPE_USER_CREATABLE }, + { NULL }) If the type is not intended to be instantiated, then then the OBJECT_DEFINE_ABSTRACT_TYPE() macro can be used instead: @@ -368,7 +370,8 @@ the OBJECT_DEFINE_ABSTRACT_TYPE() macro can be used instead: .. code-block:: c :caption: Defining a simple abstract type - OBJECT_DEFINE_ABSTRACT_TYPE(MyDevice, my_device, MY_DEVICE, DEVICE) + OBJECT_DEFINE_ABSTRACT_TYPE(MyDevice, my_device, + MY_DEVICE, DEVICE)
Long code lines don't look good in the rendered documents, make them shorter. Signed-off-by: Eduardo Habkost <ehabkost@redhat.com> --- docs/devel/qom.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-)