diff options
| author | Aki Niemi <aki.niemi@nokia.com> | 2011-01-19 10:32:30 +0200 |
|---|---|---|
| committer | Aki Niemi <aki.niemi@nokia.com> | 2011-01-19 10:36:42 +0200 |
| commit | 893e14d39d633f5bc21b85287f9e0351e7886c1c (patch) | |
| tree | 33457c5a446c01d328ea35eff0f6d35c66833557 /doc/network-api.txt | |
| parent | 2c7b1348aad16b65e4326a04e7b399656b6aaac9 (diff) | |
| download | ofono-893e14d39d633f5bc21b85287f9e0351e7886c1c.tar.bz2 | |
doc: Fix network API documentation
The Name properties in NetworkRegistration and in NetworkOperator are
not identical, and are actually used for different purposes.
Diffstat (limited to 'doc/network-api.txt')
| -rw-r--r-- | doc/network-api.txt | 11 |
1 files changed, 5 insertions, 6 deletions
diff --git a/doc/network-api.txt b/doc/network-api.txt index e94884b7..3e705e66 100644 --- a/doc/network-api.txt +++ b/doc/network-api.txt @@ -136,11 +136,6 @@ Properties string Mode [readonly] display on the idle screen or an empty string if not registered to a network. - This value is idential to the Name property from - the network operator object. It is provided here - for simplicity of application that don't allow - manual registration. - byte Strength [readonly, optional] Contains the current signal strength as a percentage @@ -188,7 +183,11 @@ Signals PropertyChanged(string property, variant value) Properties string Name [readonly] - Contains the name of the operator + Contains the name of the operator, suitable for using + as a string handle in a UI widget used for manual + network selection. For a proper display name of the + current operator, use the Name property of the + NetworkRegistration interface instead. string Status [readonly] |