From f5ee4a1ff7794991f6d6020d89392fe76ffd37b1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BCrg=20Lehni?= Date: Wed, 27 Jul 2011 22:01:51 +0100 Subject: [PATCH] Improve documentation for Matrix#createInverse(). --- src/basic/Matrix.js | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/basic/Matrix.js b/src/basic/Matrix.js index 5ac69a6a..309ff4cd 100644 --- a/src/basic/Matrix.js +++ b/src/basic/Matrix.js @@ -478,8 +478,12 @@ var Matrix = this.Matrix = Base.extend(/** @lends Matrix# */{ }, /** - * @return {Matrix} An Matrix object representing the inverse - * transformation. + * Inverts the transformation of the matrix. If the matrix is not invertible + * (in which case {@link #isSingular()} returns true), {@code null } is + * returned. + * + * @return {Matrix} The inverted matrix, or {@code null }, if the matrix is + * singular. */ createInverse: function() { var det = this.getDeterminant();