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

Add missing docs for Point.negate() function #1946

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open
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
1 change: 1 addition & 0 deletions AUTHORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,4 @@
- Scott Kieronski <[email protected]>
- Samuel Asensi <[email protected]>
- Takahiro Nishino <[email protected]>
- Piotr Wilczynski <[email protected]>
12 changes: 12 additions & 0 deletions src/basic/Point.js
Original file line number Diff line number Diff line change
Expand Up @@ -688,6 +688,18 @@ var Point = Base.extend(/** @lends Point# */{
return new Point(this.x % point.x, this.y % point.y);
},

/**
* Returns new point with both coordinates negated.
* @name Point#negate
* @function
* @operator
* @returns {Point} negation of both coordinates as new point.
*
* @example
* var point = new Point(12, -6);
* console.log(-point); // {x: -12, y: 6}
* console.log(point.negate()); // {x: -12, y: 6}
*/
negate: function() {
return new Point(-this.x, -this.y);
},
Expand Down