Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: fix esdoc #722

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions esdoc.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
{
"source": "./lib",
"destination": "./pages",
"plugins": [
{"name": "esdoc-es7-plugin"}
]
"plugins": [{"name": "@itsjamie/esdoc-standard-plugin"}]
}
1 change: 1 addition & 0 deletions lib/decorators/element.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ const { registerOrUpdateElement } = require('atom-utils')
* placing the `include` decorator after the `element` one as shown in the
* second example.**
*
* @param {Class} cls the class to decorate
* @param {string} elementName the node name of the element to register
* @return {Function} the element class as returned by
* `document.registerElement`
Expand Down
1 change: 1 addition & 0 deletions lib/decorators/include.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
/**
* Generates a decorator function to includes many `mixto` mixins into a class.
*
* @param {Class} cls the class to decorate
* @param {...Mixin} mixins the mixins to include in the class
* @return {function(cls:Function):Function} the decorator function that will
* include the specified mixins
Expand Down
29 changes: 15 additions & 14 deletions lib/minimap-element.js
Original file line number Diff line number Diff line change
Expand Up @@ -1045,9 +1045,10 @@ class MinimapElement {
/**
* Callback triggered when the mouse is pressed on the MinimapElement canvas.
*
* @param {number} y the vertical coordinate of the event
* @param {boolean} isLeftMouse was the left mouse button pressed?
* @param {boolean} isMiddleMouse was the middle mouse button pressed?
* @param {object} opts an options object with the following properties
* @param {number} opts.y the vertical coordinate of the event
* @param {boolean} opts.isLeftMouse was the left mouse button pressed?
* @param {boolean} opts.isMiddleMouse was the middle mouse button pressed?
* @access private
*/
canvasPressed ({ y, isLeftMouse, isMiddleMouse }) {
Expand All @@ -1065,9 +1066,7 @@ class MinimapElement {
* Callback triggered when the mouse left button is pressed on the
* MinimapElement canvas.
*
* @param {MouseEvent} e the mouse event object
* @param {number} e.pageY the mouse y position in page
* @param {HTMLElement} e.target the source of the event
* @param {number} y the mouse y position in page
* @access private
*/
canvasLeftMousePressed (y) {
Expand Down Expand Up @@ -1114,8 +1113,7 @@ class MinimapElement {
* Callback triggered when the mouse middle button is pressed on the
* MinimapElement canvas.
*
* @param {MouseEvent} e the mouse event object
* @param {number} e.pageY the mouse y position in page
* @param {number} y the mouse y position in page
* @access private
*/
canvasMiddleMousePressed (y) {
Expand Down Expand Up @@ -1203,9 +1201,10 @@ class MinimapElement {
* A method triggered when the mouse is pressed over the visible area that
* starts the dragging gesture.
*
* @param {number} y the vertical coordinate of the event
* @param {boolean} isLeftMouse was the left mouse button pressed?
* @param {boolean} isMiddleMouse was the middle mouse button pressed?
* @param {object} opts an options object with the following properties
* @param {number} opts.y the vertical coordinate of the event
* @param {boolean} opts.isLeftMouse was the left mouse button pressed?
* @param {boolean} opts.isMiddleMouse was the middle mouse button pressed?
* @access private
*/
startDrag ({ y, isLeftMouse, isMiddleMouse }) {
Expand Down Expand Up @@ -1251,9 +1250,11 @@ class MinimapElement {
/**
* The method called during the drag gesture.
*
* @param {number} y the vertical coordinate of the event
* @param {boolean} isLeftMouse was the left mouse button pressed?
* @param {boolean} isMiddleMouse was the middle mouse button pressed?
* @param {object} opts an options object with the following properties
* @param {number} opts.y the vertical coordinate of the event
* @param {boolean} opts.isLeftMouse was the left mouse button pressed?
* @param {boolean} opts.isMiddleMouse was the middle mouse button pressed?
* @param {object} initial an object with the following properties
* @param {number} initial.dragOffset the mouse offset within the visible
* area
* @param {number} initial.offsetTop the MinimapElement offset at the moment
Expand Down
3 changes: 2 additions & 1 deletion lib/minimap.js
Original file line number Diff line number Diff line change
Expand Up @@ -578,7 +578,8 @@ class Minimap {
/**
* Sets the scroll top of the `TextEditor`.
*
* @param {number} scrollTop the new scroll top value
* @param {number} scrollTop the new scroll top value
* @param {boolean} ignoreTextEditorScroll ignore TeextEditor scroll
*/
setTextEditorScrollTop (scrollTop, ignoreTextEditorScroll = false) {
this.ignoreTextEditorScroll = ignoreTextEditorScroll
Expand Down
8 changes: 5 additions & 3 deletions lib/mixins/canvas-drawer.js
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,7 @@ module.exports = class CanvasDrawer extends Mixin {
* changes.
*
* @param {Function} method the render method to use for the lines drawing
* @param {Array<Object>} intactRanges the intact ranges in the minimap
* @param {Array<Object>} ranges the intact ranges in the minimap
* @param {number} firstRow the first row of the rendered region
* @param {number} lastRow the last row of the rendered region
* @access private
Expand Down Expand Up @@ -408,8 +408,9 @@ module.exports = class CanvasDrawer extends Mixin {
/**
* Returns an array of tokens by line.
*
* @param {number} startRow The start row
* @param {number} endRow The end row
* @param {number} startRow The start row
* @param {number} endRow The end row
* @param {Function} callback The callback
* @return {Array<Array>} An array of tokens by line
* @access private
*/
Expand Down Expand Up @@ -751,6 +752,7 @@ module.exports = class CanvasDrawer extends Mixin {
*
* @param {number} firstRow the first row of the rendered region
* @param {number} lastRow the last row of the rendered region
* @param {Array<Object>} changes an array of changes
* @return {Array<Object>} the intact ranges in the rendered region
* @access private
*/
Expand Down
Loading