doc: Mark clock API as experimental for now
authorMarcel Holtmann <marcel@holtmann.org>
Fri, 9 Dec 2011 11:14:03 +0000 (13:14 +0200)
committerMarcel Holtmann <marcel@holtmann.org>
Fri, 9 Dec 2011 11:14:03 +0000 (13:14 +0200)
doc/clock-api.txt

index 4ec31606a94eeba67095c1acc43a8ee2aa863b6c..6818f5a826ea306a6e9c0a9893d816bf322db6ee 100644 (file)
@@ -5,14 +5,14 @@ Service               net.connman
 Interface      net.connman.Clock
 Object path    /
 
-Methods                dict GetProperties()
+Methods                dict GetProperties()  [experimental]
 
                        Returns all system clock properties. See the
                        properties section for available properties.
 
                        Possible Errors: [service].Error.InvalidArguments
 
-               void SetProperty(string name, variant value)
+               void SetProperty(string name, variant value)  [experimental]
 
                        Changes the value of the specified property. Only
                        properties that are listed as read-write are
@@ -22,13 +22,13 @@ Methods             dict GetProperties()
                        Possible Errors: [service].Error.InvalidArguments
                                         [service].Error.InvalidProperty
 
-Signals                PropertyChanged(string name, variant value)
+Signals                PropertyChanged(string name, variant value)  [experimental]
 
                        This signal indicates a changed value of the given
                        property.
 
 
-Properties     uint64 Time [readonly or readwrite]
+Properties     uint64 Time [readonly or readwrite]  [experimental]
 
                        Current system time in seconds since epoch.
 
@@ -44,7 +44,7 @@ Properties    uint64 Time [readonly or readwrite]
                        time should be using gettimeofday() and related
                        system calls.
 
-               string TimeUpdates [readwrite]
+               string TimeUpdates [readwrite]  [experimental]
 
                        Possible values are "manual" and "auto" to indicate
                        time update policy.
@@ -53,7 +53,7 @@ Properties    uint64 Time [readonly or readwrite]
                        many sources as possible to determine the correct
                        and updated time.
 
-               string Timezone [readonly or readwrite]
+               string Timezone [readonly or readwrite]  [experimental]
 
                        Current system timezone string. Allowed values
                        are from the standard timezone data (tzdata)
@@ -66,7 +66,7 @@ Properties    uint64 Time [readonly or readwrite]
                        When the timezone gets changed a PropertyChanged
                        signal will be send out.
 
-               string TimezoneUpdates [readwrite]
+               string TimezoneUpdates [readwrite]  [experimental]
 
                        Possible values are "manual" and "auto" to indicate
                        timezone update policy.
@@ -75,7 +75,7 @@ Properties    uint64 Time [readonly or readwrite]
                        many sources as possible to determine the correct
                        timezone.
 
-               array{string} Timeservers [readwrite]
+               array{string} Timeservers [readwrite]  [experimental]
 
                        List of global default NTP servers. The list should
                        be sorted in order of preference.