A whole lot of documentation clean-up.

This commit is contained in:
Jürg Lehni 2015-06-16 17:50:37 +02:00
parent 0d8deb4a9e
commit b541088c6f
28 changed files with 265 additions and 246 deletions

View file

@ -17,7 +17,7 @@
*/
var Formatter = Base.extend(/** @lends Formatter# */{
/**
* @param {Number} [precision=5] the amount of fractional digits.
* @param {Number} [precision=5] the amount of fractional digits
*/
initialize: function(precision) {
this.precision = precision || 5;

View file

@ -161,12 +161,12 @@ var Numerical = new function() {
* http://www.cs.berkeley.edu/~wkahan/Math128/Cubic.pdf
* Blinn J. - "How to solve a Quadratic Equation"
*
* @param {Number} a The quadratic term.
* @param {Number} b The linear term.
* @param {Number} c The constant term.
* @param {Number[]} roots The array to store the roots in.
* @param {Number} a The quadratic term
* @param {Number} b The linear term
* @param {Number} c The constant term
* @param {Number[]} roots The array to store the roots in
* @return {Number} The number of real roots found, or -1 if there are
* infinite solutions.
* infinite solutions
*
* @author Harikrishnan Gopalakrishnan
*/
@ -254,10 +254,10 @@ var Numerical = new function() {
* @param {Number} a The cubic term ( term).
* @param {Number} b The quadratic term ( term).
* @param {Number} c The linear term (x term).
* @param {Number} d The constant term.
* @param {Number[]} roots The array to store the roots in.
* @param {Number} d The constant term
* @param {Number[]} roots The array to store the roots in
* @return {Number} The number of real roots found, or -1 if there are
* infinite solutions.
* infinite solutions
*
* @author Harikrishnan Gopalakrishnan
*/