From fad84b6d3b21f65af1e66f0660905ef47fabaf7f Mon Sep 17 00:00:00 2001 From: Philip Gerke Date: Tue, 10 May 2022 17:06:01 +0200 Subject: [PATCH 1/2] doc: Add documentation URL to README PG-142 --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0f7a7f3..3be4813 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,8 @@ npm install --save freeathome-local-api-client ## Documentation -A sample project illustrating the use of the library can be found at https://github.com/pgerke/freeathome-local-api-sample. +The client library is documented using JSDoc, the generated documentation is available at https://pgerke.github.io/freeathome-local-api-client/. +There is also a sample project illustrating the use of the library can be found at https://github.com/pgerke/freeathome-local-api-sample. ## I found a bug, what do I do? From 707af4d2d84d66c1c7e813752fccfecde631fe05 Mon Sep 17 00:00:00 2001 From: Philip Gerke Date: Sat, 14 May 2022 13:00:57 +0200 Subject: [PATCH 2/2] doc: Complete the API documentation PG-142 --- docs/Channel.html | 723 +++++++++++++++++- docs/Configuration.html | 21 +- docs/Device.html | 554 +++++++++++++- docs/DeviceList.html | 21 +- docs/DeviceResponse.html | 21 +- docs/Devices.html | 21 +- docs/Error.html | 280 ++++++- docs/Floors.html | 21 +- docs/GetDataPointResponse.html | 21 +- docs/InOutPut.html | 186 ++++- docs/Rooms.html | 21 +- docs/ScenesTriggered.html | 28 +- docs/SetDataPointResponse.html | 21 +- docs/SysAP.html | 467 ++++++++++- docs/SystemAccessPoint.html | 296 +++++-- docs/SystemAccessPoint_SystemAccessPoint.html | 58 +- docs/Users.html | 21 +- docs/VirtualDevice.html | 279 ++++++- docs/VirtualDeviceResponse.html | 21 +- docs/WebSocketMessage.html | 21 +- docs/global.html | 315 +++++++- docs/index.html | 63 ++ docs/model_channel.ts.html | 34 +- docs/model_configuration.ts.html | 26 +- docs/model_device-list.ts.html | 23 +- docs/model_device-response.ts.html | 28 +- docs/model_device.ts.html | 32 +- docs/model_devices.ts.html | 28 +- docs/model_error.ts.html | 37 +- docs/model_floors.ts.html | 28 +- docs/model_get-data-point-response.ts.html | 27 +- docs/model_in-out-put.ts.html | 27 +- docs/model_rooms.ts.html | 27 +- docs/model_scenes-triggered.ts.html | 31 +- docs/model_set-data-point-response.ts.html | 27 +- docs/model_sys-ap.ts.html | 30 +- docs/model_users.ts.html | 33 +- docs/model_validator.ts.html | 61 +- docs/model_virtual-device-response.ts.html | 29 +- docs/model_virtual-device.ts.html | 73 +- docs/model_websocket-message.ts.html | 29 +- docs/system-access-point.ts.html | 90 ++- jsdoc.json | 23 +- package.json | 2 +- src/model/channel.ts | 15 +- src/model/configuration.ts | 7 +- src/model/device-list.ts | 4 +- src/model/device-response.ts | 9 +- src/model/device.ts | 13 +- src/model/devices.ts | 9 +- src/model/error.ts | 18 +- src/model/floors.ts | 9 +- src/model/get-data-point-response.ts | 8 +- src/model/in-out-put.ts | 8 +- src/model/rooms.ts | 8 +- src/model/scenes-triggered.ts | 12 +- src/model/set-data-point-response.ts | 8 +- src/model/sys-ap.ts | 11 +- src/model/users.ts | 14 +- src/model/validator.ts | 42 +- src/model/virtual-device-response.ts | 10 +- src/model/virtual-device.ts | 54 +- src/model/websocket-message.ts | 10 +- src/system-access-point.ts | 71 +- 64 files changed, 4126 insertions(+), 439 deletions(-) diff --git a/docs/Channel.html b/docs/Channel.html index 7b38ac3..25be047 100644 --- a/docs/Channel.html +++ b/docs/Channel.html @@ -40,6 +40,10 @@
@@ -52,6 +56,15 @@ Documentation + + + + GitHub + +
@@ -64,6 +77,10 @@ id="sidebarNav" > +
+ +
+