docs: update typed documentation and API report

zwave-js · Apr 12, 2024 · 6e26600 · 6e26600
1 parent 4b028c5
commit 6e26600
Show file tree

Hide file tree

Showing 7 changed files with 154 additions and 129 deletions.
diff --git a/docs/api/node.md b/docs/api/node.md
@@ -946,7 +946,7 @@ If the `Z-Wave+` Command Class is supported, this returns the `Z-Wave+` node typ
 
 ```ts
 enum ZWavePlusNodeType {
-	Node = 0,
+	Node = 0, // ZWave+ Node
 	IPGateway = 2,
 }
 ```

diff --git a/packages/cc/api.md b/packages/cc/api.md
@@ -7926,9 +7926,9 @@ export enum HumidityControlSetpointType {
     // (undocumented)
     "De-humidifier" = 2,
     // (undocumented)
-    "N/A" = 0,
+    "N/A" = 0,// CC v1
     // (undocumented)
-    "Auto" = 3,
+    "Auto" = 3,// CC v1
     // (undocumented)
     "Humidifier" = 1
 }
@@ -10195,21 +10195,21 @@ export function isTransportServiceEncapsulation(command: CommandClass): command
 // @public (undocumented)
 export enum KEXFailType {
     // (undocumented)
-    BootstrappingCanceled = 6,
+    BootstrappingCanceled = 6,// KEX_KEY
     // (undocumented)
-    Decrypt = 5,
+    Decrypt = 5,// KEX_SCHEME
     // (undocumented)
-    DifferentKey = 10,
+    DifferentKey = 10,// KEX_CURVES
     // (undocumented)
     KeyNotGranted = 8,
     // (undocumented)
-    NoKeyMatch = 1,
+    NoKeyMatch = 1,// CANCEL
     // (undocumented)
-    NoSupportedCurve = 3,
+    NoSupportedCurve = 3,// AUTH
     // (undocumented)
-    NoSupportedScheme = 2,
+    NoSupportedScheme = 2,// GET
     // (undocumented)
-    NoVerify = 9,
+    NoVerify = 9,// VERIFY
     // (undocumented)
     WrongSecurityLevel = 7
 }
@@ -17676,25 +17676,25 @@ export enum ThermostatSetpointType {
     // (undocumented)
     "Auto Changeover" = 10,
     // (undocumented)
-    "Away Cooling" = 14,
+    "Away Cooling" = 14,// CC v1
     // (undocumented)
-    "Away Heating" = 13,
+    "Away Heating" = 13,// CC v1
     // (undocumented)
-    "Dry Air" = 8,
+    "Dry Air" = 8,// CC v1
     // (undocumented)
-    "Energy Save Cooling" = 12,
+    "Energy Save Cooling" = 12,// CC v1
     // (undocumented)
-    "Energy Save Heating" = 11,
+    "Energy Save Heating" = 11,// CC v1
     // (undocumented)
-    "Full Power" = 15,
+    "Full Power" = 15,// CC v1
     // (undocumented)
-    "Moist Air" = 9,
+    "Moist Air" = 9,// CC v2
     // (undocumented)
-    "N/A" = 0,
+    "N/A" = 0,// CC v2
     // (undocumented)
-    "Cooling" = 2,
+    "Cooling" = 2,// CC v2
     // (undocumented)
-    "Furnace" = 7,
+    "Furnace" = 7,// CC v3
     // (undocumented)
     "Heating" = 1
 }
@@ -20525,7 +20525,7 @@ export enum ZWavePlusCommand {
 // @public (undocumented)
 export enum ZWavePlusNodeType {
     // (undocumented)
-    IPGateway = 2,
+    IPGateway = 2,// ZWave+ Node
     // (undocumented)
     Node = 0
 }

diff --git a/packages/config/api.md b/packages/config/api.md
@@ -847,6 +847,8 @@ export class NotificationParameterWithDuration {
 export class NotificationParameterWithEnum {
     constructor(definition: JSONObject);
     // (undocumented)
+    readonly default?: number;
+    // (undocumented)
     readonly values: ReadonlyMap<number, string>;
 }
 

diff --git a/packages/core/api.md b/packages/core/api.md
@@ -484,7 +484,7 @@ export enum ConfigValueFormat {
     // (undocumented)
     Enumerated = 2,
     // (undocumented)
-    SignedInteger = 0,
+    SignedInteger = 0,// UnsignedInt, Radio Buttons
     // (undocumented)
     UnsignedInteger = 1
 }
@@ -504,15 +504,15 @@ export const CONTROLLER_LABEL = "CNTRLR";
 // @public (undocumented)
 export enum ControllerCapabilityFlags {
     // (undocumented)
-    NoNodesIncluded = 32,
+    NoNodesIncluded = 32,// Controller is a secondary
     // (undocumented)
-    OnOtherNetwork = 2,
+    OnOtherNetwork = 2,// Controller is using a home ID from another network
     // (undocumented)
-    Secondary = 1,
+    Secondary = 1,// There's a SUC id server (SIS) on the network
     // (undocumented)
-    SISPresent = 4,
+    SISPresent = 4,// Before the SIS was added, the controller was the primary
     // (undocumented)
-    SUC = 16,
+    SUC = 16,// Controller is a static update controller (SUC)
     // (undocumented)
     WasRealPrimary = 8
 }
@@ -1464,7 +1464,7 @@ export type LogValueArgs<T> = T & {
 // @public (undocumented)
 export enum LongRangeChannel {
     // (undocumented)
-    A = 1,
+    A = 1,// Reserved
     // (undocumented)
     B = 2,
     // (undocumented)
@@ -3488,6 +3488,8 @@ export interface ZWaveLogInfo<TContext extends LogContext = LogContext> extends
 
 // Warnings were encountered during analysis:
 //
+// src/security/Manager2.ts:116:79 - (tsdoc-escape-greater-than) The ">" character should be escaped using a backslash to avoid confusion with an HTML tag
+// src/security/Manager2.ts:116:98 - (tsdoc-escape-greater-than) The ">" character should be escaped using a backslash to avoid confusion with an HTML tag
 // src/security/QR.ts:99:3 - (ae-unresolved-link) The @link reference could not be resolved: The package "@zwave-js/core" does not have an export "requestedSecurityClasses"
 
 // (No @packageDocumentation comment for this package)

diff --git a/packages/nvmedit/api.md b/packages/nvmedit/api.md
@@ -430,7 +430,7 @@ export enum PageStatus {
 // @public (undocumented)
 export enum PageWriteSize {
     // (undocumented)
-    WRITE_SIZE_16 = 1,
+    WRITE_SIZE_16 = 1,// Only single writes are allowed
     // (undocumented)
     WRITE_SIZE_32 = 0
 }