Commit 9be488b0 authored by David Zeuthen's avatar David Zeuthen

fix up the D-Bus docs somewhat

parent a946db04
......@@ -19,7 +19,7 @@
</arg>
<arg name="identities" direction="in" type="a(sa{sv})">
<annotation name="org.gtk.EggDBus.DocString" value="A list of identities of that the user can use for authentication."/>
<annotation name="org.gtk.EggDBus.DocString" value="A list of #Identity structs that the user can use for authentication."/>
</arg>
</method>
......
......@@ -8,17 +8,20 @@
<!-- Authorization struct -->
<annotation name="org.gtk.EggDBus.DeclareStruct" value="Authorization">
<annotation name="org.gtk.EggDBus.DocString.Summary" value="Authorizations"/>
<annotation name="org.gtk.EggDBus.DocString" value="This struct describes an authorization belonging to an #Identity."/>
<annotation name="org.gtk.EggDBus.Struct.Member" value="s:action_id">
<annotation name="org.gtk.EggDBus.DocString" value="Identifier for the action the authorization is for"/>
<annotation name="org.gtk.EggDBus.DocString" value="Identifier for the action the authorization is for."/>
</annotation>
<annotation name="org.gtk.EggDBus.Struct.Member" value="(sa{sv}):subject">
<annotation name="org.gtk.EggDBus.StructType" value="Subject"/>
<annotation name="org.gtk.EggDBus.DocString" value="Subject that the authorization applies to"/>
<annotation name="org.gtk.EggDBus.DocString" value="The #Subject that the authorization applies to."/>
</annotation>
<annotation name="org.gtk.EggDBus.Struct.Member" value="b:is_negative">
<annotation name="org.gtk.EggDBus.DocString" value="Whether the authorization is negative"/>
<annotation name="org.gtk.EggDBus.DocString" value="Whether the authorization is negative."/>
</annotation>
</annotation>
......@@ -26,7 +29,7 @@
<annotation name="org.gtk.EggDBus.DocString" value="Enumerate all users known to the authority."/>
<arg name="users" direction="out" type="a(sa{sv})">
<annotation name="org.gtk.EggDBus.DocString" value="An array of identities."/>
<annotation name="org.gtk.EggDBus.DocString" value="An array of #Identity structs."/>
<annotation name="org.gtk.EggDBus.StructType" value="Identity"/>
</arg>
</method>
......@@ -35,7 +38,7 @@
<annotation name="org.gtk.EggDBus.DocString" value="Enumerate all groups known to the authority."/>
<arg name="groups" direction="out" type="a(sa{sv})">
<annotation name="org.gtk.EggDBus.DocString" value="An array of identities."/>
<annotation name="org.gtk.EggDBus.DocString" value="An array of #Identity structs."/>
<annotation name="org.gtk.EggDBus.StructType" value="Identity"/>
</arg>
</method>
......@@ -44,11 +47,11 @@
<annotation name="org.gtk.EggDBus.DocString" value="Add an authorization to @identity."/>
<arg name="identity" direction="in" type="(sa{sv})">
<annotation name="org.gtk.EggDBus.DocString" value="The identity to add @authorization to"/>
<annotation name="org.gtk.EggDBus.DocString" value="The #Identity to add @authorization to."/>
<annotation name="org.gtk.EggDBus.StructType" value="Identity"/>
</arg>
<arg name="authorization" direction="in" type="(s(sa{sv})b)">
<annotation name="org.gtk.EggDBus.DocString" value="The authorization to add for @identity"/>
<annotation name="org.gtk.EggDBus.DocString" value="The #Authorization to add to @identity."/>
<annotation name="org.gtk.EggDBus.StructType" value="Authorization"/>
</arg>
</method>
......@@ -57,11 +60,11 @@
<annotation name="org.gtk.EggDBus.DocString" value="Remove an authorization from @identity."/>
<arg name="identity" direction="in" type="(sa{sv})">
<annotation name="org.gtk.EggDBus.DocString" value="The identity to remove @authorization from"/>
<annotation name="org.gtk.EggDBus.DocString" value="The #Identity to remove @authorization from."/>
<annotation name="org.gtk.EggDBus.StructType" value="Identity"/>
</arg>
<arg name="authorization" direction="in" type="(s(sa{sv})b)">
<annotation name="org.gtk.EggDBus.DocString" value="The authorization to remove from @identity"/>
<annotation name="org.gtk.EggDBus.DocString" value="The #Authorization to remove from @identity."/>
<annotation name="org.gtk.EggDBus.StructType" value="Authorization"/>
</arg>
</method>
......@@ -71,11 +74,11 @@
<arg name="identity" direction="in" type="(sa{sv})">
<annotation name="org.gtk.EggDBus.StructType" value="Identity"/>
<annotation name="org.gtk.EggDBus.DocString" value="The identity to enumerate authorizations for"/>
<annotation name="org.gtk.EggDBus.DocString" value="An #Identity to enumerate authorizations for."/>
</arg>
<arg name="authorizations" direction="out" type="a(s(sa{sv})b)">
<annotation name="org.gtk.EggDBus.StructType" value="Authorization"/>
<annotation name="org.gtk.EggDBus.DocString" value="An array of authorizations for @identity"/>
<annotation name="org.gtk.EggDBus.DocString" value="An array of #Authorization structs for @identity."/>
</arg>
</method>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment