Add 2017 to copyright

[staging/HomeScreen.git] / interfaces / appframework.xml

diff --git a/interfaces/appframework.xml b/interfaces/appframework.xml
index 1324386..f10b3ae 100644 (file)
--- a/interfaces/appframework.xml
+++ b/interfaces/appframework.xml
@@ -1,5 +1,5 @@
 <!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
-<!-- Copyright (C) 2016 Mentor Graphics Development (Deutschland) GmbH
+<!-- Copyright (C) 2016, 2017 Mentor Graphics Development (Deutschland) GmbH
 
  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
@@ -13,14 +13,45 @@
  See the License for the specific language governing permissions and
  limitations under the License. -->
 <node>
-  <interface name="org.agl.appframework">
-      <method name="getAvailableAppNames">
-        <arg name="names" type="as" direction="out"/>
-      </method>
-      <method name="launchApp">
-        <arg name="name" type="s" direction="in"/>
-        <arg name="pid" type="i" direction="out"/>
-      </method>
-  </interface>
+       <!--
+         org.agl.appframework:
+         @short_description: The interface of the app framework binder.
+
+         The app framework has to provide some basic functionality like 
+         getting a list of applications and start them. In further versions,
+         also pausing or stopping, .
+       -->
+       <interface name="org.agl.appframework">
+               <!--
+                 getAvailableApps:
+                 @apps: A list of applications that can be launched.
+
+                 The application info consists of:
+                 string id;
+                 string version;
+                 int width;
+                 int height;
+                 string name;
+                 string description;
+                 string shortname;
+                 string author;
+                 string iconPath;
+               -->
+               <method name="getAvailableApps">
+                       <arg name="apps" type="{ssiisssss}" direction="out"/>
+                       <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QList&lt;AppInfo&gt;"/>
+               </method>
+               <!--
+                 launchApp:
+                 @name: The name of the application that shall be launched.
+                 @pid: Returns the pid of the process.
+
+                 Use the id of the application info to launch the app.
+               -->
+               <method name="launchApp">
+                       <arg name="name" type="s" direction="in"/>
+                       <arg name="pid" type="i" direction="out"/>
+               </method>
+       </interface>
 </node>