Skip to content

Commit

Permalink
fix typedoc generation
Browse files Browse the repository at this point in the history
  • Loading branch information
bwp91 committed Apr 10, 2024
1 parent 4d5fb10 commit 8220ff3
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 15 deletions.
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
"@types"
],
"dependencies": {
"@homebridge/ciao": "^1.1.9-alpha.0",
"@homebridge/ciao": "^1.1.9-alpha.2",
"@homebridge/dbus-native": "^0.5.1",
"bonjour-hap": "^3.7.2",
"debug": "^4.3.4",
Expand Down
27 changes: 15 additions & 12 deletions src/lib/Accessory.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1183,18 +1183,21 @@ export class Accessory extends EventEmitter {
}

/**
* Publishes this Accessory on the local network for iOS clients to communicate with.
*
* @param {Object} info - Required info for publishing.
* @param allowInsecureRequest - Will allow unencrypted and unauthenticated access to the http server
* @param {string} info.username - The "username" (formatted as a MAC address - like "CC:22:3D:E3:CE:F6") of
* this Accessory. Must be globally unique from all Accessories on your local network.
* @param {string} info.pincode - The 8-digit pincode for clients to use when pairing this Accessory. Must be formatted
* as a string like "031-45-154".
* @param {string} info.category - One of the values of the Accessory.Category enum, like Accessory.Category.SWITCH.
* This is a hint to iOS clients about what "type" of Accessory this represents, so
* that for instance an appropriate icon can be drawn for the user while adding a
* new Accessory.
* Publishes this accessory on the local network for iOS clients to communicate with.
* - `info.username` - formatted as a MAC address, like `CC:22:3D:E3:CE:F6`, of this accessory.
* Must be globally unique from all Accessories on your local network.
* - `info.pincode` - the 8-digit pin code for clients to use when pairing this Accessory.
* Must be formatted as a string like `031-45-154`.
* - `info.category` - one of the values of the `Accessory.Category` enum, like `Accessory.Category.SWITCH`.
* This is a hint to iOS clients about what "type" of Accessory this represents, so
* that for instance an appropriate icon can be drawn for the user while adding a
* new Accessory.
* @param {{
* username: string;
* pincode: string;
* category: Accessory.Categories;
* }} info - Required info for publishing.
* @param {boolean} allowInsecureRequest - Will allow unencrypted and unauthenticated access to the http server
*/
public async publish(info: PublishInfo, allowInsecureRequest?: boolean): Promise<void> {
if (this.bridged) {
Expand Down
2 changes: 1 addition & 1 deletion typedoc.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,6 @@
"includeVersion": false,
"validation": {
"invalidLink": true,
"notExported": true
"notExported": false
}
}

0 comments on commit 8220ff3

Please sign in to comment.