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.

Sign up for GitHub

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

Jump to bottom

Add JSDoc comments for additional PaperScope methods #1818

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

Add JSDoc comments for additional PaperScope methods #1818

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0485851
Add JSDoc comments for additional PaperScope methods
lazerwalker Jun 3, 2020
5f5ff30
Word-wrap PaperScope JSDocs
lazerwalker Jun 4, 2020
17e6be0
Split up createCanvas docs into two separate blocks
lazerwalker Jun 9, 2020
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
27 changes: 25 additions & 2 deletions src/core/PaperScope.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,6 +265,27 @@ var PaperScope = Base.extend(/** @lends PaperScope# */{
return this;
},

/**
* Returns a valid HTML canvas you can use.
* Internally, this may reuse an existing canvas.
*
* @param {Number} width
* @param {Number} height
*
* @returns {HTMLCanvasElement}
*/

/**
* Returns a valid HTML canvas you can use.
* Internally, this may reuse an existing canvas.
*
* @param {Object} options An object containing the canvas width / height
Copy link
Member

@lehni lehni Jun 14, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be a Size object really, and the param name should be size then.

*
* @option width {Number}
* @option height {Number}
Copy link
Member

@lehni lehni Jun 14, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When using @option, it should include the object param name as well, so options.width and options.height in your use case. But since it should really be a Size object, this isn't even needed.

*
* @returns {HTMLCanvasElement}
*/
createCanvas: function(width, height) {
return CanvasProvider.getCanvas(width, height);
},
Expand All @@ -277,9 +298,11 @@ var PaperScope = Base.extend(/** @lends PaperScope# */{
paper = this;
},

/**
* Remove all projects, views and tools.
* This also removes the installed event handlers.
*/
clear: function() {
// Remove all projects, views and tools.
// This also removes the installed event handlers.
var projects = this.projects,
tools = this.tools;
for (var i = projects.length - 1; i >= 0; i--)
Expand Down