We are currently experiencing downtime impacting viewing & cloning the Mesa repo, and some GitLab pages returning 503. Please see #freedesktop on IRC for more updates.

Commit a946db04 authored by David Zeuthen's avatar David Zeuthen

use new eggdbus feature to include enums/structs docs in the interface docs

parent 1d0eea5d
......@@ -5,10 +5,10 @@
<interface name="org.freedesktop.PolicyKit1.AuthenticationAgent">
<annotation name="org.gtk.EggDBus.DocString.Summary" value="Authentication Agent Interface"/>
<annotation name="org.gtk.EggDBus.DocString" value="<para>This D-Bus interface is used for communication between the system-wide PolicyKit daemon and one or more authentication agents each running in a user session.</para><para>An authentication agent must implement this interface and register (passing the object path of the object implementing the interface) using the org.freedesktop.PolicyKit1.Authority.RegisterAuthenticationAgent() and org.freedesktop.PolicyKit1.Authority.UnregisterAuthenticationAgent() methods on the #org.freedesktop.PolicyKit.Authority interface of the PolicyKit daemon.</para>"/>
<annotation name="org.gtk.EggDBus.DocString" value="<para>This D-Bus interface is used for communication between the system-wide PolicyKit daemon and one or more authentication agents each running in a user session.</para><para>An authentication agent must implement this interface and register (passing the object path of the object implementing the interface) using the org.freedesktop.PolicyKit1.Authority.RegisterAuthenticationAgent() and org.freedesktop.PolicyKit1.Authority.UnregisterAuthenticationAgent() methods on the #org.freedesktop.PolicyKit1.Authority interface of the PolicyKit daemon.</para>"/>
<method name="BeginAuthentication">
<annotation name="org.gtk.EggDBus.DocString" value="<para>Called by the PolicyKit daemon when the authentication agent needs the user to authenticate as one of the identities in @identities for the action with the identifier @action_id.</para><para>Upon succesful authentication, the authentication agent must invoke the org.freedesktop.PolicyKit1.Authority.AuthenticationAgentResponse() method on the #org.freedesktop.PolicyKit.Authority interface of the PolicyKit daemon before returning.</para><para>If the user dismisses the authentication dialog, the authentication agent should return an error.</para>"/>
<annotation name="org.gtk.EggDBus.DocString" value="<para>Called by the PolicyKit daemon when the authentication agent needs the user to authenticate as one of the identities in @identities for the action with the identifier @action_id.</para><para>Upon succesful authentication, the authentication agent must invoke the org.freedesktop.PolicyKit1.Authority.AuthenticationAgentResponse() method on the #org.freedesktop.PolicyKit1.Authority interface of the PolicyKit daemon before returning.</para><para>If the user dismisses the authentication dialog, the authentication agent should return an error.</para>"/>
<arg name="action_id" direction="in" type="s">
<annotation name="org.gtk.EggDBus.DocString" value="The identifier for the action that the user is authentication for."/>
......
......@@ -2,26 +2,26 @@
"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
<node>
<!-- Authorization struct -->
<annotation name="org.gtk.EggDBus.DeclareStruct" value="Authorization">
<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>
<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>
<annotation name="org.gtk.EggDBus.Struct.Member" value="b:is_negative">
<annotation name="org.gtk.EggDBus.DocString" value="Whether the authorization is negative"/>
</annotation>
</annotation>
<interface name="org.freedesktop.PolicyKit1.AuthorityManager">
<annotation name="org.gtk.EggDBus.DocString.Summary" value="Manage an Authority"/>
<annotation name="org.gtk.EggDBus.DocString" value="This D-Bus interface <emphasis>may</emphasis> be implemented by the <literal>/org/freedesktop/PoliycKit1/Authority</literal> object on the well-known name <literal>org.freedesktop.PolicyKit1</literal> on the system message bus."/>
<!-- Authorization struct -->
<annotation name="org.gtk.EggDBus.DeclareStruct" value="Authorization">
<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>
<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>
<annotation name="org.gtk.EggDBus.Struct.Member" value="b:is_negative">
<annotation name="org.gtk.EggDBus.DocString" value="Whether the authorization is negative"/>
</annotation>
</annotation>
<method name="EnumerateUsers">
<annotation name="org.gtk.EggDBus.DocString" value="Enumerate all users known to the authority."/>
......
......@@ -25,13 +25,14 @@ agent-built-sources.stamp : Makefile.am $(top_srcdir)/data/org.freedesktop.Polic
eggdbus-binding-tool \
--namespace "_PolkitAgent" \
--dbus-namespace "org.freedesktop.PolicyKit1" \
--introspection-xml $(top_srcdir)/data/org.freedesktop.PolicyKit1.Authority.xml \
--introspection-xml $(top_srcdir)/data/org.freedesktop.PolicyKit1.AuthenticationAgent.xml \
--stamp-file agent-built-sources.stamp \
$(NULL)
# keep in sync with contents of agent-built-sources.stamp (Thanks autotools)
#
agent_built_sources = _polkitagentbindingsmarshal.c _polkitagentbindingsmarshal.h _polkitagentbindingsmarshal.list _polkitagentbindings.c _polkitagentbindings.h _polkitagentbindingstypes.h _polkitagentauthenticationagent.c _polkitagentauthenticationagent.h docbook-interface-org.freedesktop.PolicyKit1.AuthenticationAgent.xml
agent_built_sources = _polkitagentbindingsmarshal.c _polkitagentbindingsmarshal.h _polkitagentbindingsmarshal.list _polkitagentbindings.c _polkitagentbindings.h _polkitagentbindingstypes.h _polkitagentauthenticationagent.c _polkitagentauthenticationagent.h docbook-interface-org.freedesktop.PolicyKit1.AuthenticationAgent.xml _polkitagentauthority.c _polkitagentauthority.h docbook-interface-org.freedesktop.PolicyKit1.Authority.xml _polkitagentcheckauthorizationflags.c _polkitagentcheckauthorizationflags.h _polkitagentauthorizationresult.c _polkitagentauthorizationresult.h _polkitagenterror.c _polkitagenterror.h _polkitagentimplicitauthorization.c _polkitagentimplicitauthorization.h _polkitagentactiondescription.c _polkitagentactiondescription.h _polkitagentidentity.c _polkitagentidentity.h _polkitagentsubject.c _polkitagentsubject.h
marshal.stamp : Makefile.am $(srcdir)/polkitagentmarshal.list
glib-genmarshal --prefix=polkit_agent_marshal $(srcdir)/polkitagentmarshal.list --header > polkitagentmarshal.h.tmp && mv polkitagentmarshal.h.tmp polkitagentmarshal.h
......
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