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
|
@ -25,9 +25,9 @@ const CursorTool = {
|
|||
* @typedef {Object} PDFCursorToolsOptions
|
||||
* @property {HTMLDivElement} container - The document container.
|
||||
* @property {EventBus} eventBus - The application event bus.
|
||||
* @property {number} cursorToolOnLoad - (optional) The cursor tool that will be
|
||||
* enabled on load; the constants from {CursorTool} should be used.
|
||||
* The default value is `CursorTool.SELECT`.
|
||||
* @property {number} [cursorToolOnLoad] - The cursor tool that will be enabled
|
||||
* on load; the constants from {CursorTool} should be used. The default value
|
||||
* is `CursorTool.SELECT`.
|
||||
*/
|
||||
|
||||
class PDFCursorTools {
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue