From 50c7649421fe1d44f86de39ad2e990a2261e7fa9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BCrg=20Lehni?= Date: Mon, 27 Jun 2011 15:07:08 +0200 Subject: [PATCH] Improve Segment and Curve documentation. --- src/path/Curve.js | 4 ++-- src/path/Segment.js | 12 ++++++++---- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/src/path/Curve.js b/src/path/Curve.js index 231cae80..a37eece7 100644 --- a/src/path/Curve.js +++ b/src/path/Curve.js @@ -18,8 +18,8 @@ * @name Curve * * @class The Curve object represents the parts of a path that are connected by - * two following segments. The curves of a path can be accessed through its - * {@link Path#curves} array + * two following {@link Segment} objects. The curves of a path can be accessed + * through its {@link Path#curves} array. * * While a segment describe the anchor point and its incoming and outgoing * handles, a Curve object describes the curve passing between two such diff --git a/src/path/Segment.js b/src/path/Segment.js index d4a2d3fc..af950977 100644 --- a/src/path/Segment.js +++ b/src/path/Segment.js @@ -16,11 +16,15 @@ /** * @name Segment - * @class The Segment object represents a part of a path which is - * described by the {@link Path#segments} array. Every segment of a - * path corresponds to an anchor point (anchor points are the path handles - * that are visible when the path is selected). * + * @class The Segment object represents the points of a path through which its + * {@link Curve} objects pass. The segments of a path can be accessed through + * its {@link Path#segments} array. + * + * Each segment consists of an anchor point ({@link Segment#point}) and + * optionaly an incoming and an outgoing handle ({@link Segment#handleIn} and + * {@link Segment#handleOut}), describing the tangents of the two {@link Curve} + * objects that are connected by this segment. */ var Segment = this.Segment = Base.extend(/** @lends Segment# */{ /**