Skip to content

Commit 022de4d

Browse files
lehnilehni
committed
Some documentation fixes for v0.2
1 parent 4fa6ffe commit 022de4d

4 files changed

Lines changed: 31 additions & 30 deletions

File tree

‎src/core/PaperScope.js‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,8 @@ var PaperScope = this.PaperScope = Base.extend(/** @lends PaperScope# */{
126126
* paper.install(window);
127127
*/
128128
install: function(scope) {
129-
// Define project, view and tool as getters, so they are kept up to date
129+
// Define project, view and tool as getters that redirect to these
130+
// values on the PaperScope, so they are kept up to date
130131
var that = this;
131132
Base.each(['project', 'view', 'tool'], function(key) {
132133
Base.define(scope, key, {

‎src/item/HitResult.js‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,6 @@
2020
* @class A HitResult object contains information about the results of a hit
2121
* test. It is returned by {@link Item#hitTest(point)} and
2222
* {@link Project#hitTest(point)}.
23-
*
24-
* @extends CurveLocation
2523
*/
2624
HitResult = Base.extend(/** @lends HitResult# */{
2725
initialize: function(type, item, values) {

‎src/item/Item.js‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -695,18 +695,19 @@ var Item = this.Item = Base.extend(/** @lends Item# */{
695695
* <b>options.type:</b> Only hit test again a certain item
696696
* type: {@link PathItem}, {@link Raster}, {@link TextItem}, etc.
697697
* <b>options.fill:</b> {@code Boolean} - Hit test the fill of items.
698-
* <b>options.stroke:</b> {@code Boolean} - Hit test the curves of path items,
699-
* taking into account stroke width.
700-
* <b>options.segment:</b> {@code Boolean} - Hit test for {@link Segment#point} of
701-
* {@link Path} items.
698+
* <b>options.stroke:</b> {@code Boolean} - Hit test the curves of path
699+
* items, taking into account stroke width.
700+
* <b>options.segment:</b> {@code Boolean} - Hit test for
701+
* {@link Segment#point} of {@link Path} items.
702702
* <b>options.handles:</b> {@code Boolean} - Hit test for the handles
703703
* ({@link Segment#handleIn} / {@link Segment#handleOut}) of path segments.
704-
* <b>options.ends:</b> {@code Boolean} - Only hit test for the first or last
705-
* segment points of open path items.
706-
* <b>options.bounds:</b> {@code Boolean} - Hit test the corners and side-centers
707-
* of the bounding rectangle of items ({@link Item#bounds}).
708-
* <b>options.center:</b> {@code Boolean} - Hit test the {@link Rectangle#center}
709-
* of the bounding rectangle of items ({@link Item#bounds}).
704+
* <b>options.ends:</b> {@code Boolean} - Only hit test for the first or
705+
* last segment points of open path items.
706+
* <b>options.bounds:</b> {@code Boolean} - Hit test the corners and
707+
* side-centers of the bounding rectangle of items ({@link Item#bounds}).
708+
* <b>options.center:</b> {@code Boolean} - Hit test the
709+
* {@link Rectangle#center} of the bounding rectangle of items
710+
* ({@link Item#bounds}).
710711
* <b>options.guide:</b> {@code Boolean} - Hit test items that have
711712
* {@link Item#guide} set to {@code true}.
712713
* <b>options.selected:</b> {@code Boolean} - Only hit selected items.

‎src/project/Project.js‎

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -187,26 +187,27 @@ var Project = this.Project = Base.extend(/** @lends Project# */{
187187
*
188188
* The optional options object allows you to control the specifics of the
189189
* hit test and may contain a combination of the following values:
190-
* <b>tolerance:</b> {@code Number} - The tolerance of the hit test in
191-
* points.
192-
* <b>type:</b> Only hit test again a certain item
190+
* <b>options.tolerance:</b> {@code Number} - The tolerance of the hit test
191+
* in points.
192+
* <b>options.type:</b> Only hit test again a certain item
193193
* type: {@link PathItem}, {@link Raster}, {@link TextItem}, etc.
194-
* <b>fill:</b> {@code Boolean} - Hit test the fill of items.
195-
* <b>stroke:</b> {@code Boolean} - Hit test the curves of path items,
196-
* taking into account stroke width.
197-
* <b>segment:</b> {@code Boolean} - Hit test for {@link Segment#point} of
198-
* {@link Path} items.
199-
* <b>handles:</b> {@code Boolean} - Hit test for the handles
194+
* <b>options.fill:</b> {@code Boolean} - Hit test the fill of items.
195+
* <b>options.stroke:</b> {@code Boolean} - Hit test the curves of path
196+
* items, taking into account stroke width.
197+
* <b>options.segment:</b> {@code Boolean} - Hit test for
198+
* {@link Segment#point} of {@link Path} items.
199+
* <b>options.handles:</b> {@code Boolean} - Hit test for the handles
200200
* ({@link Segment#handleIn} / {@link Segment#handleOut}) of path segments.
201-
* <b>ends:</b> {@code Boolean} - Only hit test for the first or last
202-
* segment points of open path items.
203-
* <b>bounds:</b> {@code Boolean} - Hit test the corners and side-centers
204-
* of the bounding rectangle of items ({@link Item#bounds}).
205-
* <b>center:</b> {@code Boolean} - Hit test the {@link Rectangle#center}
206-
* of the bounding rectangle of items ({@link Item#bounds}).
207-
* <b>guide:</b> {@code Boolean} - Hit test items that have
201+
* <b>options.ends:</b> {@code Boolean} - Only hit test for the first or
202+
* last segment points of open path items.
203+
* <b>options.bounds:</b> {@code Boolean} - Hit test the corners and
204+
* side-centers of the bounding rectangle of items ({@link Item#bounds}).
205+
* <b>options.center:</b> {@code Boolean} - Hit test the
206+
* {@link Rectangle#center} of the bounding rectangle of items
207+
* ({@link Item#bounds}).
208+
* <b>options.guide:</b> {@code Boolean} - Hit test items that have
208209
* {@link Item#guide} set to {@code true}.
209-
* <b>selected:</b> {@code Boolean} - Only hit selected items.
210+
* <b>options.selected:</b> {@code Boolean} - Only hit selected items.
210211
*
211212
* @param {Point} point The point where the hit test should be performed
212213
* @param {Object} [options={ fill: true, stroke: true, segments: true,

0 commit comments

Comments
 (0)