From b003ed0f59d18d1ca4aba8d915d9d8a526793f42 Mon Sep 17 00:00:00 2001
From: Imran Zaman <imran.zaman@intel.com>
Date: Tue, 19 Nov 2013 14:09:26 +0200
Subject: [PATCH] added dbus interface documentation

---
 ...izen.SecurityAccounts.gUserManagement.Group.xml | 141 +++++++++++++++---
 ...curityAccounts.gUserManagement.GroupService.xml | 132 ++++++++++++++---
 ...tizen.SecurityAccounts.gUserManagement.User.xml | 164 +++++++++++++++++----
 ...ecurityAccounts.gUserManagement.UserService.xml | 132 ++++++++++++++---
 4 files changed, 474 insertions(+), 95 deletions(-)

diff --git a/src/common/dbus/interfaces/org.tizen.SecurityAccounts.gUserManagement.Group.xml b/src/common/dbus/interfaces/org.tizen.SecurityAccounts.gUserManagement.Group.xml
index a0a8f76..1abe732 100644
--- a/src/common/dbus/interfaces/org.tizen.SecurityAccounts.gUserManagement.Group.xml
+++ b/src/common/dbus/interfaces/org.tizen.SecurityAccounts.gUserManagement.Group.xml
@@ -1,26 +1,119 @@
 <!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.tizen.SecurityAccounts.gUserManagement.Group">
-    <signal name="unregistered">
-    </signal>  
-    <method name="addGroup">
-      <arg name="preferred_gid" type="u" direction="in"/>
-      <arg name="gid" type="u" direction="out"/>
-    </method>
-    <method name="deleteGroup">
-    </method>
-    <method name="updateGroup">
-    </method>
-    <method name="addMember">
-      <arg name="uid" type="u" direction="in"/>
-      <arg name="add_as_admin" type="b" direction="in"/>
-    </method>
-    <method name="deleteMember">
-      <arg name="uid" type="u" direction="in"/>
-    </method>
-    <property name="grouptype" type="q" access="readwrite"/>
-    <property name="gid" type="u" access="read"/>
-    <property name="groupname" type="s" access="readwrite"/>
-    <property name="secret" type="s" access="readwrite"/>
-  </interface>
+<node name="/Group"
+  xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
+    
+    <tp:copyright>Copyright © 2013 Intel Corporation</tp:copyright>
+    
+    <tp:license xmlns="http://www.w3.org/1999/xhtml">
+        <p>This library is free software; you can redistribute it and/or
+        modify it under the terms of the GNU Lesser General Public
+        License as published by the Free Software Foundation; either
+        version 2.1 of the License, or (at your option) any later version.
+        </p>
+    
+        <p>This library is distributed in the hope that it will be useful, but
+        WITHOUT ANY WARRANTY; without even the implied warranty of
+        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+        Lesser General Public License for more details.
+        </p>
+    
+        <p>You should have received a copy of the GNU Lesser General Public
+        License along with this library; if not, write to the Free Software
+        Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+        02110-1301 USA
+        </p>
+    </tp:license>
+    
+    <interface name="org.tizen.SecurityAccounts.gUserManagement.Group">
+    
+        <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
+            <p>User object encapsulates the necessary details of a group
+            account including adding, updating and deleting group.
+            </p>
+        </tp:docstring>
+        
+        <signal name="unregistered" tp:name-for-bindings="unregistered">
+            <tp:docstring>Signal is emitted when the group dbus object is
+            destroyed and is no more usable.
+            </tp:docstring>
+        </signal>
+        
+        <method name="addGroup" tp:name-for-bindings="addGroup">
+            <tp:docstring>Adds the group info to the group's account database. 
+            </tp:docstring>
+                    
+            <arg name="preferred_gid" type="u" direction="in">
+                <tp:docstring>preferred GID of the group
+                </tp:docstring>
+            </arg>
+            
+            <arg name="gid" type="u" direction="out">
+                <tp:docstring>GID of the group
+                </tp:docstring>
+            </arg>
+        </method>
+        
+        <method name="deleteGroup" tp:name-for-bindings="deleteGroup">
+            <tp:docstring>Deletes the group info from the group's account
+            database 
+            </tp:docstring>
+        </method>
+        
+        <method name="updateGroup" tp:name-for-bindings="updateGroup">
+            <tp:docstring>Updates the group info into the group's account
+            database 
+            </tp:docstring>
+        </method>
+        
+        <method name="addMember" tp:name-for-bindings="addMember">
+            <tp:docstring>Adds a user to the group accounts' database
+            </tp:docstring>
+            
+            <arg name="uid" type="u" direction="in">
+                <tp:docstring>UID of the user to be added to the group
+                </tp:docstring>
+            </arg>
+            
+            <arg name="add_as_admin" type="b" direction="in">
+                <tp:docstring>flag to indicate whether add the user to the
+                group as admin or not.
+                </tp:docstring>
+            </arg>
+        </method>
+
+        <method name="deleteMember" tp:name-for-bindings="deleteMember">
+            <tp:docstring>Deletes a user from the group's account database 
+            </tp:docstring>
+            
+            <arg name="uid" type="u" direction="in">
+                <tp:docstring>UID of the user to be deleted from the group
+                </tp:docstring>
+            </arg>
+        </method>
+        
+        <property name="grouptype" tp:name-for-bindings="grouptype"
+         type="q" access="readwrite">
+            <tp:docstring>Type of the group. Type can be system(1) and user(2)
+            </tp:docstring>
+        </property>
+
+        <property name="gid" tp:name-for-bindings="gid"
+         type="u" access="read">
+            <tp:docstring>id of the group
+            </tp:docstring>
+        </property>
+
+        <property name="groupname" tp:name-for-bindings="groupname"
+         type="s" access="readwrite">
+            <tp:docstring>name of the group
+            </tp:docstring>
+        </property>
+
+        <property name="secret" tp:name-for-bindings="secret"
+         type="s" access="readwrite">
+            <tp:docstring>secret used for accessing the group data
+            </tp:docstring>
+        </property>
+
+    </interface>
 </node>
diff --git a/src/common/dbus/interfaces/org.tizen.SecurityAccounts.gUserManagement.GroupService.xml b/src/common/dbus/interfaces/org.tizen.SecurityAccounts.gUserManagement.GroupService.xml
index dc65ffd..deab0a3 100644
--- a/src/common/dbus/interfaces/org.tizen.SecurityAccounts.gUserManagement.GroupService.xml
+++ b/src/common/dbus/interfaces/org.tizen.SecurityAccounts.gUserManagement.GroupService.xml
@@ -1,25 +1,111 @@
 <!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.tizen.SecurityAccounts.gUserManagement.GroupService">
-    <signal name="groupAdded">
-        <arg name="gid" type="u" direction="out"/>
-    </signal>  
-    <signal name="groupDeleted">
-        <arg name="gid" type="u" direction="out"/>
-    </signal>  
-    <signal name="groupUpdated">
-        <arg name="gid" type="u" direction="out"/>
-    </signal>  
-    <method name="createNewGroup">
-        <arg name="objectPath" type="o" direction="out"/>
-    </method>
-    <method name="getGroup">
-        <arg name="gid" type="u" direction="in"/>
-        <arg name="objectPath" type="o" direction="out"/>
-    </method>
-    <method name="getGroupByName">
-        <arg name="groupname" type="s" direction="in"/>
-        <arg name="objectPath" type="o" direction="out"/>
-    </method>
-  </interface>
+<node name="/GroupService"
+  xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
+    
+    <tp:copyright>Copyright © 2013 Intel Corporation</tp:copyright>
+    
+    <tp:license xmlns="http://www.w3.org/1999/xhtml">
+        <p>This library is free software; you can redistribute it and/or
+        modify it under the terms of the GNU Lesser General Public
+        License as published by the Free Software Foundation; either
+        version 2.1 of the License, or (at your option) any later version.
+        </p>
+    
+        <p>This library is distributed in the hope that it will be useful, but
+        WITHOUT ANY WARRANTY; without even the implied warranty of
+        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+        Lesser General Public License for more details.
+        </p>
+    
+        <p>You should have received a copy of the GNU Lesser General Public
+        License along with this library; if not, write to the Free Software
+        Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+        02110-1301 USA
+        </p>
+    </tp:license>
+    
+    <interface name="org.tizen.SecurityAccounts.gUserManagement.GroupService">
+    
+        <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
+            <p>GroupService object encapsulates the APIs to create or retrieve 
+            the dbus object of the group. Besides it emits signal when a group
+            is added, deleted or updated.
+            </p>
+        </tp:docstring>
+        
+        <signal name="groupAdded" tp:name-for-bindings="groupAdded">
+            <tp:docstring>Signal is emitted when group info is added to the
+            group's account database 
+            </tp:docstring>
+                    
+            <arg name="gid" type="u" direction="out">
+                <tp:docstring>GID of the group
+                </tp:docstring>
+            </arg>
+        </signal>
+         
+        <signal name="groupDeleted" tp:name-for-bindings="groupDeleted">
+            <tp:docstring>Signal is emitted when group info is deleted from the
+            group's account database
+            </tp:docstring>
+                    
+            <arg name="gid" type="u" direction="out">
+                <tp:docstring>GID of the group
+                </tp:docstring>
+            </arg>
+        </signal> 
+         
+        <signal name="groupUpdated" tp:name-for-bindings="groupUpdated">
+            <tp:docstring>Signal is emitted when group info is updated to the
+            group's account database
+            </tp:docstring>
+                    
+            <arg name="gid" type="u" direction="out">
+                <tp:docstring>GID of the group
+                </tp:docstring>
+            </arg>
+        </signal>
+          
+        <method name="createNewGroup" tp:name-for-bindings="createNewGroup">
+            <tp:docstring>Create new group dbus object 
+            </tp:docstring>
+                    
+            <arg name="objectPath" type="o" direction="out">
+                <tp:docstring>group dbus object path.
+                </tp:docstring>
+            </arg>
+        </method>
+        
+        <method name="getGroup" tp:name-for-bindings="getGroup">
+            <tp:docstring>Gets the group dbus object based on GID
+            </tp:docstring>
+                    
+            <arg name="gid" type="u" direction="in">
+                <tp:docstring>GID of the group
+                </tp:docstring>
+            </arg>
+            
+            <arg name="objectPath" type="o" direction="out">
+                <tp:docstring>group dbus object path
+                </tp:docstring>
+            </arg>
+        </method>
+        
+        <method name="getGroupByName" tp:name-for-bindings="getGroupByName">
+            <tp:docstring>Gets the group dbus object based on group name 
+            </tp:docstring>
+                    
+            <arg name="groupname" type="s" direction="in">
+                <tp:docstring>name of the group
+                </tp:docstring>
+            </arg>
+            
+            <arg name="objectPath" type="o" direction="out">
+                <tp:docstring>group dbus object path
+                </tp:docstring>
+            </arg>
+        </method>
+        
+    </interface>
+    
 </node>
diff --git a/src/common/dbus/interfaces/org.tizen.SecurityAccounts.gUserManagement.User.xml b/src/common/dbus/interfaces/org.tizen.SecurityAccounts.gUserManagement.User.xml
index 4518cfa..45a6cf4 100644
--- a/src/common/dbus/interfaces/org.tizen.SecurityAccounts.gUserManagement.User.xml
+++ b/src/common/dbus/interfaces/org.tizen.SecurityAccounts.gUserManagement.User.xml
@@ -1,27 +1,141 @@
 <!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.tizen.SecurityAccounts.gUserManagement.User">
-    <signal name="unregistered">
-    </signal>  
-    <method name="addUser">
-        <arg name="uid" type="u" direction="out"/>
-    </method>
-    <method name="deleteUser">
-        <arg name="rem_home_dir" type="b" direction="in"/>
-    </method>
-    <method name="updateUser">
-    </method>
-    <property name="uid" type="u" access="read"/>
-    <property name="gid" type="u" access="read"/>
-    <property name="usertype" type="q" access="readwrite"/>
-    <property name="nickname" type="s" access="readwrite"/>
-    <property name="username" type="s" access="readwrite"/>
-    <property name="secret" type="s" access="readwrite"/>
-    <property name="realname" type="s" access="readwrite"/>
-    <property name="office" type="s" access="readwrite"/>
-    <property name="officephone" type="s" access="readwrite"/>
-    <property name="homephone" type="s" access="readwrite"/>
-    <property name="homedir" type="s" access="readwrite"/>
-    <property name="shell" type="s" access="readwrite"/>
-  </interface>
+<node name="/User"
+  xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
+    
+    <tp:copyright>Copyright © 2013 Intel Corporation</tp:copyright>
+    
+    <tp:license xmlns="http://www.w3.org/1999/xhtml">
+        <p>This library is free software; you can redistribute it and/or
+        modify it under the terms of the GNU Lesser General Public
+        License as published by the Free Software Foundation; either
+        version 2.1 of the License, or (at your option) any later version.
+        </p>
+    
+        <p>This library is distributed in the hope that it will be useful, but
+        WITHOUT ANY WARRANTY; without even the implied warranty of
+        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+        Lesser General Public License for more details.
+        </p>
+    
+        <p>You should have received a copy of the GNU Lesser General Public
+        License along with this library; if not, write to the Free Software
+        Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+        02110-1301 USA
+        </p>
+    </tp:license>
+    
+    <interface name="org.tizen.SecurityAccounts.gUserManagement.User">
+    
+        <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
+            <p>User object encapsulates the necessary details of a user
+            account including adding, updating and deleting user.
+            </p>
+        </tp:docstring>
+        
+        <signal name="unregistered" tp:name-for-bindings="unregistered">
+            <tp:docstring>Signal is emitted when the user dbus object is
+            destroyed and is no more usable.
+            </tp:docstring>
+        </signal>
+        
+        <method name="addUser" tp:name-for-bindings="addUser">
+            <tp:docstring>Adds the user info to the user's account database. 
+            </tp:docstring>
+                    
+            <arg name="uid" type="u" direction="out">
+                <tp:docstring>UID of the user
+                </tp:docstring>
+            </arg>
+        </method>
+        
+        <method name="deleteUser">
+            <tp:docstring>Delete the user from the user's account database. 
+            </tp:docstring>
+                    
+            <arg name="rem_home_dir" type="b" direction="in">
+                <tp:docstring>Flag to indicate whether to remove the user home 
+                directory or not when user account is being deleted.
+                </tp:docstring>
+            </arg>
+        </method>
+        
+        <method name="updateUser">
+            <tp:docstring>Updates the user info into the user's account
+            database
+            </tp:docstring>        
+        </method>
+        
+        <property name="uid" tp:name-for-bindings="uid" type="u" access="read">
+            <tp:docstring>id of the user
+            </tp:docstring>
+        </property>
+
+        <property name="gid" tp:name-for-bindings="gid"
+         type="u" access="read">
+            <tp:docstring>group id of the user
+            </tp:docstring>
+        </property>
+
+        <property name="usertype" tp:name-for-bindings="usertype"
+         type="q" access="readwrite">
+            <tp:docstring>type of the user. Type can be system(1), admin(2),
+            guest(3) and normal(4)
+            </tp:docstring>
+        </property>
+
+        <property name="nickname" tp:name-for-bindings="nickname"
+         type="s" access="readwrite">
+            <tp:docstring>nickname of the user
+            </tp:docstring>
+        </property>
+
+        <property name="username" tp:name-for-bindings="username"
+         type="s" access="readwrite">
+            <tp:docstring>name of the user
+            </tp:docstring>
+        </property>
+
+        <property name="secret" tp:name-for-bindings="secret"
+         type="s" access="readwrite">
+            <tp:docstring>secret for the user account
+            </tp:docstring>
+        </property>
+
+        <property name="realname" tp:name-for-bindings="realname"
+         type="s" access="readwrite">
+            <tp:docstring>real name of the user
+            </tp:docstring>
+        </property>
+
+        <property name="office" tp:name-for-bindings="office"
+         type="s" access="readwrite">
+            <tp:docstring>office location of the user
+            </tp:docstring>
+        </property>
+
+        <property name="officephone" tp:name-for-bindings="officephone"
+         type="s" access="readwrite">
+            <tp:docstring>office phone of the user
+            </tp:docstring>
+        </property>
+
+        <property name="homephone" tp:name-for-bindings="homephone"
+         type="s" access="readwrite">
+            <tp:docstring>home phone of the user
+            </tp:docstring>
+        </property>
+
+        <property name="homedir" tp:name-for-bindings="homedir"
+         type="s" access="readwrite">
+            <tp:docstring>path of the home directory of user
+            </tp:docstring>
+        </property>
+
+        <property name="shell" tp:name-for-bindings="shell"
+         type="s" access="readwrite">
+            <tp:docstring>path of the shell binary
+            </tp:docstring>
+        </property>
+
+    </interface>
 </node>
diff --git a/src/common/dbus/interfaces/org.tizen.SecurityAccounts.gUserManagement.UserService.xml b/src/common/dbus/interfaces/org.tizen.SecurityAccounts.gUserManagement.UserService.xml
index 792efde..7028d0e 100644
--- a/src/common/dbus/interfaces/org.tizen.SecurityAccounts.gUserManagement.UserService.xml
+++ b/src/common/dbus/interfaces/org.tizen.SecurityAccounts.gUserManagement.UserService.xml
@@ -1,25 +1,111 @@
 <!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.tizen.SecurityAccounts.gUserManagement.UserService">
-    <signal name="userAdded">
-        <arg name="uid" type="u" direction="out"/>
-    </signal>  
-    <signal name="userDeleted">
-        <arg name="uid" type="u" direction="out"/>
-    </signal>  
-    <signal name="userUpdated">
-        <arg name="uid" type="u" direction="out"/>
-    </signal>  
-    <method name="createNewUser">
-        <arg name="objectPath" type="o" direction="out"/>
-    </method>
-    <method name="getUser">
-        <arg name="uid" type="u" direction="in"/>
-        <arg name="objectPath" type="o" direction="out"/>
-    </method>
-    <method name="getUserByName">
-        <arg name="username" type="s" direction="in"/>
-        <arg name="objectPath" type="o" direction="out"/>
-    </method>
-  </interface>
+<node name="/UserService"
+  xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
+    
+    <tp:copyright>Copyright © 2013 Intel Corporation</tp:copyright>
+    
+    <tp:license xmlns="http://www.w3.org/1999/xhtml">
+        <p>This library is free software; you can redistribute it and/or
+        modify it under the terms of the GNU Lesser General Public
+        License as published by the Free Software Foundation; either
+        version 2.1 of the License, or (at your option) any later version.
+        </p>
+    
+        <p>This library is distributed in the hope that it will be useful, but
+        WITHOUT ANY WARRANTY; without even the implied warranty of
+        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+        Lesser General Public License for more details.
+        </p>
+    
+        <p>You should have received a copy of the GNU Lesser General Public
+        License along with this library; if not, write to the Free Software
+        Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+        02110-1301 USA
+        </p>
+    </tp:license>
+    
+    <interface name="org.tizen.SecurityAccounts.gUserManagement.UserService">
+    
+        <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
+            <p>UserService object encapsulates the APIs to create or retrieve 
+            the dbus object of the user. Besides it emits signal when a user is
+            added, deleted or updated.
+            </p>
+        </tp:docstring>
+        
+        <signal name="userAdded" tp:name-for-bindings="userAdded">
+            <tp:docstring>Signal is emitted when user info is added to the
+            user's account database
+            </tp:docstring>
+                    
+            <arg name="uid" type="u" direction="out">
+                <tp:docstring>UID of the user
+                </tp:docstring>
+            </arg>
+        </signal>
+          
+        <signal name="userDeleted" tp:name-for-bindings="userDeleted">
+            <tp:docstring>Signal is emitted when user info is deleted from the
+            user's account database
+            </tp:docstring>
+                    
+            <arg name="uid" type="u" direction="out">
+                <tp:docstring>UID of the user
+                </tp:docstring>
+            </arg>
+        </signal>
+          
+        <signal name="userUpdated" tp:name-for-bindings="userUpdated">
+            <tp:docstring>Signal is emitted when user info is updated to the
+            user's account database
+            </tp:docstring>
+                    
+            <arg name="uid" type="u" direction="out">
+                <tp:docstring>UID of the user
+                </tp:docstring>
+            </arg>
+        </signal>
+          
+        <method name="createNewUser" tp:name-for-bindings="createNewUser">
+            <tp:docstring>Create new user dbus object
+            </tp:docstring>
+                    
+            <arg name="objectPath" type="o" direction="out">
+                <tp:docstring>user dbus object path
+                </tp:docstring>
+            </arg>
+        </method>
+        
+        <method name="getUser" tp:name-for-bindings="getUser">
+            <tp:docstring>Gets the user dbus object based on UID 
+            </tp:docstring>
+                    
+            <arg name="uid" type="u" direction="in">
+                <tp:docstring>UID of the user
+                </tp:docstring>
+            </arg>
+            
+            <arg name="objectPath" type="o" direction="out">
+                <tp:docstring>user dbus object path
+                </tp:docstring>
+            </arg>
+        </method>
+        
+        <method name="getUserByName" tp:name-for-bindings="getUserByName">
+            <tp:docstring>Gets the user dbus object based on user name 
+            </tp:docstring>
+                    
+            <arg name="username" type="s" direction="in">
+                 <tp:docstring>name of the user
+                </tp:docstring>
+            </arg>
+            
+            <arg name="objectPath" type="o" direction="out">
+                <tp:docstring>user dbus object path
+                </tp:docstring>
+            </arg>
+        </method>
+        
+    </interface>
+    
 </node>
-- 
2.7.4