Commit graph

7173 commits

Author SHA1 Message Date
sasensi
449c5c3e6d Fix Tween#then() documentation.
Bug introduced in 9c684091f4: example
variable was renamed from `item` to `circle` in declaration but later
calls were still done with `item`.
2018-12-03 15:04:22 +01:00
sasensi
a7c2fb3ddf Improve Color.random() documentation. 2018-12-03 14:46:50 +01:00
sasensi
b8a0743e3d Avoid using _ as parameter name. 2018-12-03 14:41:47 +01:00
sasensi
f25690aa91 Rename type definition file to paper.d.ts. 2018-12-03 14:41:47 +01:00
sasensi
bbd65324bc Add typescript definition generation
This add a gulp task (`gulp docs:typescript`) to automatically generate
a typescript definition for the library. This should solve the problem
of having an out of sync type definition when we change the API.

This task takes advantage of existing JSDoc parsing to generate a
temporary file which is later formatted through a mustache template to
generate the final definition. This definition is then tested by
compiling a typescript file that use it.
The generated definition is added to the `gulp zip` task in order to be
published along with the bundled library.

So 2 new dev-dependencies are added with this change: `mustache` and
`typescript` packages. Using node and mustache to generate the
definition instead of relying on existing templating system is
motivated by a better development experience, with easier debugging
possibilities... through the usage of more modern tools.

As a side note, support of "rest parameters" (when a parameter can be
present multiple times) is added to existing JSDoc parser in order to
support this pattern on typescript side (E.g. for `Color#set()` method
which accept any sequence of parameters that is supported by `Color`
constructors).
2018-12-03 14:41:47 +01:00
Jürg Lehni
0cced9788c Switch back to load.js versions on develop branch. 2018-12-03 14:29:13 +01:00
Jürg Lehni
a66391678e Release version 0.12.0 2018-12-03 14:26:23 +01:00
Jürg Lehni
8ef5773ea1 Update CHANGELOG for upcoming v0.12.0 2018-12-03 14:19:11 +01:00
Jürg Lehni
4a5f558057 Some minor tween example changes 2018-12-03 13:59:51 +01:00
Jürg Lehni
9c684091f4 Move Tween class to anim namespace + changes
- Change from item to object, as it can be used to tween any property on any object really
- Make _handleFrame() private
- Minor documentation tweaks
2018-12-03 12:51:31 +01:00
arnoson
104d5eeef1
Merge pull request #1622 from sasensi/add/tween-documentation
Add Tween documentation
2018-12-03 10:27:10 +01:00
sasensi
a97382d1c5 Document tween update event as Tween#onUpdate. 2018-12-03 09:44:37 +01:00
sasensi
6d411e9b7f Add Tween documentation 2018-11-30 15:10:31 +01:00
sasensi
f2b6e67bcb Fix Item#tweenFrom() documentation example.
Example code was not matching example title.
2018-11-30 12:07:01 +01:00
sasensi
266cf365f5 Fix Item#tween() documentation. 2018-11-30 11:50:10 +01:00
Jürg Lehni
e52a33b9cb Fix linting errors 2018-11-29 14:10:08 +01:00
arnoson
684f504930 Implement tweening 2018-11-29 12:04:03 +01:00
Jürg Lehni
d46b6cbef4 Fix Emitter.once() 2018-11-28 11:40:17 +01:00
Jürg Lehni
b1705f628b Fix typos 2018-11-21 11:58:22 +01:00
sasensi
a4a2fb7eef Fix various documentation problems
- typos in comments
- wrong or missing types
- missing default values
2018-11-21 11:27:51 +01:00
sasensi
b363a5cc95 Remove Line from documentation
Line class was not displayed in online documentation but it was parsed
and a file was created for it because it lacked a @private JSDoc tag.
2018-11-21 11:21:51 +01:00
sasensi
dd2c15ac83 Add documentation for Color.random() 2018-11-21 11:18:02 +01:00
Takahiro Nishino
27d9903c74
Merge pull request #1609 from sapics/doc/add-param-type-in-raster-method
Add param type in raster method
2018-11-20 08:53:17 +09:00
sapics
531479c0a0 Add param type in raster method
Add param type in Raster#getPixel and Raster#setPixel
2018-11-20 08:44:38 +09:00
sasensi
ef7beacd8b Fix several return values documentation 2018-11-17 09:37:06 +01:00
sasensi
12731f2fd1 Fix typo in Raster#getCanvas documentation 2018-11-16 18:58:18 +01:00
sapics
cfc5a912da Replace url to avoid redirection
Replace http://jonathanpuckey.com to https://puckey.studio
2018-11-14 11:24:32 +01:00
sapics
d8f9eb8890 Replace http to https in comment
http://www.w3.org/TR/SVG/* to https://www.w3.org/TR/SVG/*
2018-11-14 11:24:04 +01:00
sapics
c219bb7345 Replace http to https in comment 2018-11-14 11:22:29 +01:00
Samuel Asensi
2968faad51 Fix empty image drawing (#1605)
Empty raster (for example coming from path with empty bound
rasterization, ...) drawing threw error.
This change prevent raster drawing in that case.
Closes #1320
2018-11-14 11:21:40 +01:00
sasensi
8202f78453 Fix typo in Color#convert documentation 2018-11-13 10:12:59 +01:00
sasensi
1462178799 Fix typo in Path(pathData) documentation
Empty parameter was resulting in `Path(pathData)` being documented as
`Path(, pathData)` with an empty first parameter.
2018-11-13 09:52:19 +01:00
sasensi
910aecb7e5 Fix CurveLocation#distance documentation
@see tag was pointing to an inherited method which is not compatible
with current jsdoc parser implementation.
Problem is resolved by making reference point to the parent class
owning the method.
2018-11-12 16:44:36 +01:00
sasensi
8b33eccd52 Fix beans documentation links
Several documentation "see also" links concerning beans were broken
because they were referenced as `ClassName#getProperty()` instead of
`ClassName#property`.
2018-11-12 16:38:34 +01:00
sasensi
0b52720bdf Fix CompoundPath#lastSegment documentation 2018-11-12 16:27:23 +01:00
sasensi
6301aeb82d Fix Raster#context documented type 2018-11-12 16:20:39 +01:00
sasensi
4f545d243b Fix unexisting type Symbol in documentation 2018-11-12 16:18:05 +01:00
sasensi
bb63310578 Fix CurveLocation#index documented type 2018-11-12 16:12:01 +01:00
sasensi
df109ab096 Fix typo in PathItem documentation
PathItem was misspelled PahtItem, breaking documentation links.
2018-11-12 16:08:04 +01:00
sasensi
d3f617b98e Fix Path#divide() documentation
Divide operation was described as subtract & subtract instead of
subtract & intersect.
2018-11-09 14:24:04 +01:00
sasensi
655a4dabd0 Add tolerance parameter to test method compareCanvas() 2018-11-06 12:07:01 +01:00
sasensi
337538b21a Remove reference to CanvasProvider in test methods 2018-11-06 11:26:12 +01:00
sasensi
2e75467fb4 Fix group selected bounds and position color
Group selected color was applied differently to its bounds and position
depending on whether it had children or not when selected color was set.
This resulted in an unpredictable behaviour from a user point of view.
To change that:
- When `item.setSelectedColor()` is called, value is now always stored
in `item._style._values`, independently from the fact that item has
children or not.
- An helper method `compareCanvas()` is added to the test suite to allow
comparing selection rendering of a known working case to a failing one.
Two provided callbacks are executed in a dedicated `<canvas>`/`Project`
context and both results are compared with `resemble.js`.
2018-11-06 11:26:12 +01:00
sasensi
c44f56d52f Fix Rectangle documentation
Add missing return values in Rectangle boolean operations.
Closes #1399
2018-11-05 08:34:50 +01:00
sasensi
97b87e3836 Fix crashing build disabling node v11
Node v11 is temporarily disabled from ci build until a bug is fixed in
resemblejs package.
2018-11-05 08:31:25 +01:00
sapics
b52c22dd39 Travis: Remove node v9 and add node v10 2018-10-25 22:34:10 +02:00
sasensi
8ce5cc97cc Minor code cleaning 2018-10-20 15:59:18 +02:00
sasensi
e9135589b1 Fix mousedrag error with in front items
When dragging item A behind item B, mousedrag event was emitted on
item B instead of mousemove.
Bug introduced in fbd5eeb
Closes #1465
2018-10-20 15:59:18 +02:00
sapics
f50a81e089 Minor code minifier
We can minify some codes which relate matrix.decompose(),
because matrix.decompose() must return non-null object
2018-10-20 15:14:41 +02:00
sasensi
6a3b8fc384 Minor code refactoring to try to make online build pass 2018-10-17 18:08:54 +02:00