From: Marcel Holtmann <marcel@holtmann.org>
Date: Wed, 11 Mar 2009 16:17:36 +0000 (+0100)
Subject: Add skeleton for profile API description
X-Git-Tag: 2.0_alpha~4001
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=6bf9ea4781e346af8faa5cea4e6734f13b7bb3f3;p=framework%2Fconnectivity%2Fconnman.git

Add skeleton for profile API description
---

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 745841b..995f998 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -38,4 +38,4 @@ EXTRA_DIST = $(DOC_MAIN_SGML_FILE) connman-introduction.xml
 endif
 
 EXTRA_DIST += manager-api.txt device-api.txt network-api.txt service-api.txt \
-				connection-api.txt agent-api.txt plugin-api.txt
+		connection-api.txt profile-api.txt agent-api.txt plugin-api.txt
diff --git a/doc/profile-api.txt b/doc/profile-api.txt
new file mode 100644
index 0000000..e4aa535
--- /dev/null
+++ b/doc/profile-api.txt
@@ -0,0 +1,22 @@
+Profile hierarchy
+=================
+
+Service		org.moblin.connman
+Interface	org.moblin.connman.Profile
+Object path	[variable prefix]/{profile0,profile1,...}
+
+Methods		dict GetProperties()
+
+			Returns properties for the profile object. See
+			the properties section for available properties.
+
+			Possible Errors: [service].Error.InvalidArguments
+
+Signals		PropertyChanged(string name, variant value)
+
+			This signal indicates a changed value of the given
+			property.
+
+Properties	string Name [readonly]
+
+			Name of this profile.