Skip to content

Commit

Permalink
docs: fix missing members in generated doc
Browse files Browse the repository at this point in the history
  • Loading branch information
ahwayakchih committed Jan 12, 2025
1 parent 206af60 commit 214448c
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 0 deletions.
9 changes: 9 additions & 0 deletions lib/configuration.js
Original file line number Diff line number Diff line change
Expand Up @@ -64,61 +64,70 @@ function Configuration () {
* Name used for files, if they are not specified otherwise.
*
* @type {string}
* @name module:crx3/lib/configuration.Configuration#name
*/
this.name = '';
/**
* Path name of output CRX file.
*
* @type {string}
* @name module:crx3/lib/configuration.Configuration#crxPath
* @default './web-extension.crx'
*/
this.crxPath = DEFAULT_CRX_PATH;
/**
* Optional path name of output ZIP file.
*
* @type {string}
* @name module:crx3/lib/configuration.Configuration#zipPath
* @default ''
*/
this.zipPath = '';
/**
* Private key to be used for signing CRX file.
*
* @type {string}
* @name module:crx3/lib/configuration.Configuration#keyPath
* @default ''
*/
this.keyPath = '';
/**
* Optional path name of output Update Manifest XML file.
*
* @type {string}
* @name module:crx3/lib/configuration.Configuration#xmlPath
* @default ''
*/
this.xmlPath = '';
/**
* Optional version name to be written into Upate Manifest file.
*
* @type {string}
* @name module:crx3/lib/configuration.Configuration#appVersion
* @default undefined
*/
this.appVersion = undefined; // eslint-disable-line no-undefined
/**
* Optional extension file URL name to be written into Upate Manifest file.
*
* @type {string}
* @name module:crx3/lib/configuration.Configuration#crxURL
* @default undefined
*/
this.crxURL = undefined; // eslint-disable-line no-undefined
/**
* Optional minimum supported browser version name, e.g., '70.0.0'.
*
* @type {string}
* @name module:crx3/lib/configuration.Configuration#browserVersion
* @default undefined
*/
this.browserVersion = undefined; // eslint-disable-line no-undefined
/**
* List of paths to include.
*
* @type {string[]}
* @name module:crx3/lib/configuration.Configuration#srcPaths
* @default []
*/
this.srcPaths = [];
Expand Down
1 change: 1 addition & 0 deletions lib/crx3stream.js
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,7 @@ function CRX3StreamState (cfg, pos = 0) {
*/
this.appId = null;
/**
* @name module:crx3/lib/crx3stream.CRX3StreamState~encodedAppId
* @type {string}
*/
this.encodedAppId = '';
Expand Down

0 comments on commit 214448c

Please sign in to comment.