Skip to content

Commit

Permalink
doc/dbus: Questions1.*.doc.xml now pass make check
Browse files Browse the repository at this point in the history
The @Result output argument is unfortunately unnamed in zbus(Rust)
introspection so we have to document it in plain text
  • Loading branch information
mvidner committed Jul 14, 2023
1 parent 721c5ee commit f6429d7
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 26 deletions.
16 changes: 16 additions & 0 deletions doc/dbus/org.opensuse.Agama.Questions1.Generic.doc.xml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,22 @@
-->
<property name="Answer" type="s" access="readwrite"/>

<!--
Class:
String identifier of the same questions.
Useful to identify similar questions asked multiple times
or for matching in automatic answers.
-->
<property name="Class" access="read" type="s"></property>

<!--
Data:
Additional data that is specific to given question class.
Can be used for additional details about question that helps with UI
or with matching automatic answers.
-->
<property name="Data" access="read" type="a{ss}"></property>

<!--
DefaultOption:
Clients should offer this option as default option for answering the question.
Expand Down
19 changes: 0 additions & 19 deletions doc/dbus/org.opensuse.Agama.Questions1.LuksActivation.doc.xml

This file was deleted.

12 changes: 12 additions & 0 deletions doc/dbus/org.opensuse.Agama.Questions1.WithPassword.doc.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
<node>
<interface name="org.opensuse.Agama.Questions1.WithPassword">
<!--
Password:
Password provided to decrypt whatever appropriate.
-->
<property name="Password" type="s" access="readwrite"/>
</interface>
</node>

18 changes: 11 additions & 7 deletions doc/dbus/org.opensuse.Agama.Questions1.doc.xml
Original file line number Diff line number Diff line change
Expand Up @@ -36,20 +36,22 @@ when the question is answered and the answer is successfully read.
@data: additional data that is specific to given question class. Can be
used for additional details about question that helps with UI
or with matching automatic answers.
@result: Object path of created question.
Creates new generic question
Creates new generic question.
Returns the object path of the created question.
-->
<method name="New">
<arg name="class" direction="in" type="s"/>
<arg name="text" direction="in" type="s"/>
<arg name="options" direction="in" type="as"/>
<arg name="default_option" direction="in" type="s"/>
<arg name="data" direction="in" type="a{ss}"/>
<arg name="result" direction="out" type="o"/>
<arg direction="out" type="o"/>
</method>

<!--
New:
NewWithPassword:
@class: string identifier of the same questions. Useful to identify
similar questions asked multiple times or for matching
in automatic answers.
Expand All @@ -62,28 +64,30 @@ when the question is answered and the answer is successfully read.
@data: additional data that is specific to given question class. Can be
used for additional details about question that helps with UI
or with matching automatic answers.
@result: Object path of created question.
Creates new question with generic base and additional WithPassword interface.
Returns the object path of the created question.
-->
<method name="NewWithPassword">
<arg name="class" direction="in" type="s"/>
<arg name="text" direction="in" type="s"/>
<arg name="options" direction="in" type="as"/>
<arg name="default_option" direction="in" type="s"/>
<arg name="data" direction="in" type="a{ss}"/>
<arg name="result" direction="out" type="o"/>
<arg direction="out" type="o"/>
</method>
<method name="Delete">
<arg name="question" direction="in" type="o"/>
</method>

<!--
UseDefaultAnswer:
Switches questions to be automatically answered by default answer.
After this method call each follow up question is immediatelly answered.
Useful for doing non interactive installation.
-->
<method name="UseDefaultAnswer" />
<method name="UseDefaultAnswer">
</method>
</interface>
</node>

0 comments on commit f6429d7

Please sign in to comment.