aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorItay Grudev <itay@grudev.com>2016-08-15 23:08:05 +0100
committerItay Grudev <itay@grudev.com>2016-08-15 23:08:05 +0100
commit5f0c8a33168b4acf2e3ddc79f13e0437de770f28 (patch)
treebdb71ed79b7a1eefdbcaa5bd253c92fdc422f515 /README.md
parentImproved `instanceStarted()` note in `README.md`. (diff)
downloadsingleapplication-5f0c8a33168b4acf2e3ddc79f13e0437de770f28.tar.xz
Improved documentation styling. Added HRs between API members.
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index 9d398d9..7803224 100644
--- a/README.md
+++ b/README.md
@@ -147,6 +147,8 @@ and the secondary instance.*
user, in which case the User/System modes will have no effect and the block will
be user wide.*
+---
+
```cpp
bool SingleApplication::sendMessage( QByteArray message, int timeout = 100 )
```
@@ -154,17 +156,23 @@ bool SingleApplication::sendMessage( QByteArray message, int timeout = 100 )
Sends `message` to the Primary Instance. Uses `timeout` as a the maximum timeout
in milliseconds for blocking functions
+---
+
```cpp
bool SingleApplication::isPrimary()
```
Returns if the instance is the primary instance.
+---
+
```cpp
bool SingleApplication::isSecondary()
```
Returns if the instance is a secondary instance.
+---
+
```cpp
quint32 SingleApplication::instanceId()
```
@@ -180,12 +188,16 @@ void SingleApplication::instanceStarted()
Triggered whenever a new instance had been started, except for secondary
instances if the `Mode::SecondaryNotification` flag is not specified.
+---
+
```cpp
void SingleApplication::receivedMessage( quint32 instanceId, QByteArray message )
```
Triggered whenever there is a message received from a secondary instance.
+---
+
### Flags
```cpp
@@ -206,6 +218,8 @@ and the secondary instance.*
user, in which case the User/System modes will have no effect and the block will
be user wide.*
+---
+
Versioning
----------