mirror of
https://github.com/zen-browser/pdf.js.git
synced 2025-07-08 09:20:06 +02:00
Consistently use square brackets for optional parameters in JSDoc comments
Square brackets are recommended to indicate optional parameters. Using them helps for automatically generating correct documentation.
This commit is contained in:
parent
efd331daa1
commit
f4daafc077
21 changed files with 136 additions and 138 deletions
|
@ -32,11 +32,11 @@ const SWIPE_ANGLE_THRESHOLD = Math.PI / 6;
|
|||
/**
|
||||
* @typedef {Object} PDFPresentationModeOptions
|
||||
* @property {HTMLDivElement} container - The container for the viewer element.
|
||||
* @property {HTMLDivElement} viewer - (optional) The viewer element.
|
||||
* @property {HTMLDivElement} [viewer] - The viewer element.
|
||||
* @property {PDFViewer} pdfViewer - The document viewer.
|
||||
* @property {EventBus} eventBus - The application event bus.
|
||||
* @property {Array} contextMenuItems - (optional) The menu items that are added
|
||||
* to the context menu in Presentation Mode.
|
||||
* @property {Array} [contextMenuItems] - The menu items that are added to the
|
||||
* context menu in Presentation Mode.
|
||||
*/
|
||||
|
||||
class PDFPresentationMode {
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue