Skip to content

Commit

Permalink
improves doc
Browse files Browse the repository at this point in the history
  • Loading branch information
chrvadala committed Feb 8, 2025
1 parent 38d172c commit ffca8d3
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
12 changes: 6 additions & 6 deletions docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,11 @@ Any value could be a float or a string that contains a float</p>
<dd><p>Parse a string formatted as matrix(a,b,c,d,e,f)</p>
</dd>
<dt><del><a href="#fromStringLegacy">fromStringLegacy(string)</a> ⇒ <code>Matrix</code></del></dt>
<dd><p>Parse a string formatted as matrix(a,b,c,d,e,f)</p>
<dd><p>Parse a string formatted as matrix(a,b,c,d,e,f) - Legacy implementation of <code>fromString(matrix)</code>;
Read this PR for details <a href="https://github.com/chrvadala/transformation-matrix/pull/107">https://github.com/chrvadala/transformation-matrix/pull/107</a></p>
</dd>
<dt><a href="#fromTransformAttribute">fromTransformAttribute(transformString)</a> ⇒ <code>Array.&lt;MatrixDescriptor&gt;</code></dt>
<dd><p>Parser for SVG Trasform Attribute <a href="http://www.w3.org/TR/SVG/coords.html#TransformAttribute">http://www.w3.org/TR/SVG/coords.html#TransformAttribute</a> <br/>
Warning: This should be considered BETA until it is released a stable version of pegjs.</p>
<dd><p>Parser for SVG Trasform Attribute <a href="http://www.w3.org/TR/SVG/coords.html#TransformAttribute">http://www.w3.org/TR/SVG/coords.html#TransformAttribute</a> <br/></p>
</dd>
<dt><a href="#fromTriangles">fromTriangles(t1, t2)</a> ⇒ <code>Matrix</code></dt>
<dd><p>Returns a matrix that transforms a triangle t1 into another triangle t2, or throws an exception if it is impossible.</p>
Expand Down Expand Up @@ -294,9 +294,10 @@ Parse a string formatted as matrix(a,b,c,d,e,f)
<a name="fromStringLegacy"></a>

## ~~fromStringLegacy(string) ⇒ <code>Matrix</code>~~
***this is the legacy implementation***
***Deprecated***

Parse a string formatted as matrix(a,b,c,d,e,f)
Parse a string formatted as matrix(a,b,c,d,e,f) - Legacy implementation of `fromString(matrix)`;
Read this PR for details [https://github.com/chrvadala/transformation-matrix/pull/107](https://github.com/chrvadala/transformation-matrix/pull/107)

**Kind**: global function
**Returns**: <code>Matrix</code> - Affine Matrix
Expand All @@ -314,7 +315,6 @@ Parse a string formatted as matrix(a,b,c,d,e,f)

## fromTransformAttribute(transformString) ⇒ <code>Array.&lt;MatrixDescriptor&gt;</code>
Parser for SVG Trasform Attribute http://www.w3.org/TR/SVG/coords.html#TransformAttribute <br/>
Warning: This should be considered BETA until it is released a stable version of pegjs.

**Kind**: global function
**Returns**: <code>Array.&lt;MatrixDescriptor&gt;</code> - Array of MatrixDescriptor
Expand Down
5 changes: 3 additions & 2 deletions src/fromString.js
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,10 @@ export function fromString (string) {
}

/**
* Parse a string formatted as matrix(a,b,c,d,e,f)
* Parse a string formatted as matrix(a,b,c,d,e,f) - Legacy implementation of `fromString(matrix)`;
* Read this PR for details {@link https://github.com/chrvadala/transformation-matrix/pull/107}
* @param string {string} String with an affine matrix
* @deprecated this is the legacy implementation
* @deprecated
* @returns {Matrix} Affine Matrix
*
* @example
Expand Down

0 comments on commit ffca8d3

Please # to comment.