mirrors/SingleApplication
1
0
Fork 0
mirror of https://github.com/itay-grudev/SingleApplication.git synced 2024-11-15 20:25:43 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improved documentation styling. Added HRs between API members.

Browse Source
This commit is contained in:
Itay Grudev 2016-08-15 23:08:05 +01:00
parent 9185336561
commit 5f0c8a3316
No known key found for this signature in database
GPG Key ID: 913C021BA6F9DE98
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -147,6 +147,8 @@ and the secondary instance.*
user, in which case the User/System modes will have no effect and the block will user, in which case the User/System modes will have no effect and the block will
be user wide.* be user wide.*
---
```cpp ```cpp
bool SingleApplication::sendMessage( QByteArray message, int timeout = 100 ) 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 Sends `message` to the Primary Instance. Uses `timeout` as a the maximum timeout
in milliseconds for blocking functions in milliseconds for blocking functions
---
```cpp ```cpp
bool SingleApplication::isPrimary() bool SingleApplication::isPrimary()
``` ```
Returns if the instance is the primary instance. Returns if the instance is the primary instance.
---
```cpp ```cpp
bool SingleApplication::isSecondary() bool SingleApplication::isSecondary()
``` ```
Returns if the instance is a secondary instance. Returns if the instance is a secondary instance.
---
```cpp ```cpp
quint32 SingleApplication::instanceId() quint32 SingleApplication::instanceId()
``` ```
@ -180,12 +188,16 @@ void SingleApplication::instanceStarted()
Triggered whenever a new instance had been started, except for secondary Triggered whenever a new instance had been started, except for secondary
instances if the `Mode::SecondaryNotification` flag is not specified. instances if the `Mode::SecondaryNotification` flag is not specified.
---
```cpp ```cpp
void SingleApplication::receivedMessage( quint32 instanceId, QByteArray message ) void SingleApplication::receivedMessage( quint32 instanceId, QByteArray message )
``` ```
Triggered whenever there is a message received from a secondary instance. Triggered whenever there is a message received from a secondary instance.
---
### Flags ### Flags
```cpp ```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 user, in which case the User/System modes will have no effect and the block will
be user wide.* be user wide.*
---
Versioning Versioning
---------- ----------