Skip to content
This repository has been archived by the owner on Apr 9, 2024. It is now read-only.

Commit

Permalink
docs(uat): update README.md files by adding Generate documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
bgklika committed Aug 22, 2023
1 parent 4fe8983 commit ebd9539
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
2 changes: 2 additions & 0 deletions uat/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,8 @@ mvn javadoc:javadoc
```
The main html-file will be located in each module by path **target/site/apidocs/index.html**

See individual README.md files for Python and C clients.

## Limitations
MQTT clients based on IoT Device SDK for Java v2, mosquitto C, Paho Java, Paho Python do no provide API to get information from PUBREC/PUBREL/PUBCOMP packages used when messages published with QoS 2.

Expand Down
18 changes: 17 additions & 1 deletion uat/custom-components/client-mosquitto-c/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ MQTT 3.1.1/5.0 client for tests based on C mosquitto library

## Install requirements for native build
```bash
sudo apt-get install -y build-essential gcc cmake git autoconf libtool pkg-config libmosquitto-dev
sudo apt-get install -y build-essential gcc cmake git autoconf libtool pkg-config libmosquitto-dev doxygen
```
Note: required version 2.0 or above of mosquitto

Expand Down Expand Up @@ -68,3 +68,19 @@ In Mosquitto API mosquitto_unsubscribe_v5_callback_set() callback does not provi

4. Windows implementation
mosquitto library can build on Windows but miss threaded interface and can works only in synchronous mode. That brokes logic of gRPC requests and client control.


## Generate documentation

Install doxygen

```bash
apt-get install -y doxygen
```

Run command
```bash
doxygen
```

Directory "docs" with the html and latex documentation will be generated.

0 comments on commit ebd9539

Please sign in to comment.