diff options
| author | Marcel Holtmann <marcel@holtmann.org> | 2009-03-11 17:17:36 +0100 |
|---|---|---|
| committer | Marcel Holtmann <marcel@holtmann.org> | 2009-03-11 17:17:36 +0100 |
| commit | 6bf9ea4781e346af8faa5cea4e6734f13b7bb3f3 (patch) | |
| tree | 597c320af1b7de98196855000a161ba16bd8008a /doc | |
| parent | 883c2ef2cfc898a8be08eb46557c19170a0479e8 (diff) | |
| download | connman-6bf9ea4781e346af8faa5cea4e6734f13b7bb3f3.tar.gz connman-6bf9ea4781e346af8faa5cea4e6734f13b7bb3f3.tar.bz2 connman-6bf9ea4781e346af8faa5cea4e6734f13b7bb3f3.zip | |
Add skeleton for profile API description
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile.am | 2 | ||||
| -rw-r--r-- | doc/profile-api.txt | 22 |
2 files changed, 23 insertions, 1 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 745841be..995f9985 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 00000000..e4aa5358 --- /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. |