summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSzymon Janc <szymon.janc@tieto.com>2012-11-12 14:33:11 +0100
committerSamuel Ortiz <sameo@linux.intel.com>2012-11-21 15:31:40 +0100
commitd61546e37aac6c8a46db44ab3cdc05e984560cec (patch)
tree67d6d0f768a37aaea1c9f90d7e3e7a225e7ead4a /doc
parent8701f685d3565b1d8022ba5ef6daa3d500b61c5b (diff)
downloadneard-d61546e37aac6c8a46db44ab3cdc05e984560cec.tar.gz
neard-d61546e37aac6c8a46db44ab3cdc05e984560cec.tar.bz2
neard-d61546e37aac6c8a46db44ab3cdc05e984560cec.zip
doc: Some small issues cleanup
Fix some whitespace, line-over-80 and typos issues.
Diffstat (limited to 'doc')
-rw-r--r--doc/adapter-api.txt13
-rw-r--r--doc/agent-api.txt2
-rw-r--r--doc/manager-api.txt7
-rw-r--r--doc/tag-api.txt9
4 files changed, 17 insertions, 14 deletions
diff --git a/doc/adapter-api.txt b/doc/adapter-api.txt
index fe01b3a..eace943 100644
--- a/doc/adapter-api.txt
+++ b/doc/adapter-api.txt
@@ -27,8 +27,8 @@ Methods: dict GetProperties()
the adapter will start polling for targets, listening
for NFC devices or both.
The mode parameter can have the following values:
- "Initiator", "Target" or "Dual". For any other value, the
- adapter will fall back to initiator mode.
+ "Initiator", "Target" or "Dual". For any other value
+ the adapter will fall back to initiator mode.
Dual mode will have the adapter alternate between target
and initiator modes during the polling loop.
@@ -85,7 +85,7 @@ Signals PropertyChanged(string name, variant value)
This signal is sent whenever an NFC tag is found,
as a result of a probe response reception.
-
+
The dictionary contains basically the same values
that are returned by the GetProperties method
from the org.neard.Tag interface.
@@ -96,7 +96,7 @@ Signals PropertyChanged(string name, variant value)
in sight, or when it's been de-activated.
-Properties: string Mode [readonly]
+Properties string Mode [readonly]
The adapter mode.
@@ -108,8 +108,9 @@ Properties: string Mode [readonly]
boolean Polling [readonly]
- Indicates that the adapter is currently polling for targets.
- This is only valid when the adapter is in initiator mode.
+ Indicates that the adapter is currently polling for
+ targets. This is only valid when the adapter is in
+ initiator mode.
array{string} Protocols [readonly]
diff --git a/doc/agent-api.txt b/doc/agent-api.txt
index cbb0681..c9c5122 100644
--- a/doc/agent-api.txt
+++ b/doc/agent-api.txt
@@ -104,4 +104,4 @@ Fields array{byte} NDEF
object Record
- This is a record object path.
+ This is a record object path.
diff --git a/doc/manager-api.txt b/doc/manager-api.txt
index 47547ff..d89f8ef 100644
--- a/doc/manager-api.txt
+++ b/doc/manager-api.txt
@@ -37,7 +37,7 @@ Methods dict GetProperties()
Register new NDEF agent.
- When a record macthing the registered type is found,
+ When a record matching the registered type is found,
the agent will get the whole NDEF as a raw byte stream.
Possible Errors: org.neard.Error.InvalidArguments
@@ -47,7 +47,7 @@ Methods dict GetProperties()
Unregister an existing NDEF agent.
Possible Errors: org.neard.Error.InvalidArguments
-
+
Signals PropertyChanged(string name, variant value)
@@ -62,6 +62,7 @@ Signals PropertyChanged(string name, variant value)
Parameter is the object path of removed adapter.
-Properties array{object} Adapters [readonly]
+
+Properties array{object} Adapters [readonly]
List of adapter object paths.
diff --git a/doc/tag-api.txt b/doc/tag-api.txt
index daddadc..b13a90c 100644
--- a/doc/tag-api.txt
+++ b/doc/tag-api.txt
@@ -117,7 +117,8 @@ Properties string Type [readonly]
This is the complete URI, including the scheme and
the resource.
- This property is only valid for SmartPoster's URI records.
+ This property is only valid for SmartPoster's URI
+ records.
string MIMEType [readonly]
@@ -145,6 +146,6 @@ Properties string Type [readonly]
This one is only valid for Smart Posters and is a
suggestion only. It can be ignored, and the possible
values are "Do" (for example launch the browser),
- "Save" (for example save the URI in the bookmarks folder,
- or "Edit" (for example open the URI in an URI editor for
- the user to modify it.
+ "Save" (for example save the URI in the bookmarks
+ folder, or "Edit" (for example open the URI in an URI
+ editor for the user to modify it.