Change color.js typing to be "number" instead of "integer" (#501)

* refactor(color): change type in function documentation

* doc(color): regenerate doc with new types

---------

Co-authored-by: Raffael Dipietro <raffael.dipietro@infomaniak.com>
This commit is contained in:
Raffael Di Pietro 2025-05-24 09:09:36 +02:00 committed by GitHub
parent 2148143379
commit 8c3cbd2cc8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 32 additions and 32 deletions

View File

@ -60,35 +60,35 @@
</div> </div>
<div id="main" class="main"> <div id="main" class="main">
<h1>RGBAColor</h1> <h1>RGBAColor</h1>
<div class="description">RGBA color object. Components are integers in the range of 0..255.</div> <div class="description">RGBA color object. Components are numbers in the range of 0..255.</div>
<h2>Constructor</h2> <h2>Constructor</h2>
<div class="function_container"> <div class="function_container">
<div id="RGBAColor" class="function_signature">new RGBAColor (r, g, b, a)</div> <div id="RGBAColor" class="function_signature">new RGBAColor (r, g, b, a)</div>
<div class="function_title">Parameters</div> <div class="function_title">Parameters</div>
<div class="parameter_header"> <div class="parameter_header">
<span class="parameter_name">r</span> <span class="parameter_name">r</span>
<span class="type parameter_type">integer</span> <span class="type parameter_type">number</span>
</div> </div>
<div class="parameter_main"> <div class="parameter_main">
<div class="parameter_description">Red component.</div> <div class="parameter_description">Red component.</div>
</div> </div>
<div class="parameter_header"> <div class="parameter_header">
<span class="parameter_name">g</span> <span class="parameter_name">g</span>
<span class="type parameter_type">integer</span> <span class="type parameter_type">number</span>
</div> </div>
<div class="parameter_main"> <div class="parameter_main">
<div class="parameter_description">Green component.</div> <div class="parameter_description">Green component.</div>
</div> </div>
<div class="parameter_header"> <div class="parameter_header">
<span class="parameter_name">b</span> <span class="parameter_name">b</span>
<span class="type parameter_type">integer</span> <span class="type parameter_type">number</span>
</div> </div>
<div class="parameter_main"> <div class="parameter_main">
<div class="parameter_description">Blue component.</div> <div class="parameter_description">Blue component.</div>
</div> </div>
<div class="parameter_header"> <div class="parameter_header">
<span class="parameter_name">a</span> <span class="parameter_name">a</span>
<span class="type parameter_type">integer</span> <span class="type parameter_type">number</span>
</div> </div>
<div class="parameter_main"> <div class="parameter_main">
<div class="parameter_description">Alpha component.</div> <div class="parameter_description">Alpha component.</div>
@ -102,28 +102,28 @@
<div class="function_title">Parameters</div> <div class="function_title">Parameters</div>
<div class="parameter_header"> <div class="parameter_header">
<span class="parameter_name">r</span> <span class="parameter_name">r</span>
<span class="type parameter_type">integer</span> <span class="type parameter_type">number</span>
</div> </div>
<div class="parameter_main"> <div class="parameter_main">
<div class="parameter_description">Red component.</div> <div class="parameter_description">Red component.</div>
</div> </div>
<div class="parameter_header"> <div class="parameter_header">
<span class="parameter_name">g</span> <span class="parameter_name">g</span>
<span class="type parameter_type">integer</span> <span class="type parameter_type">number</span>
</div> </div>
<div class="parameter_main"> <div class="parameter_main">
<div class="parameter_description">Green component.</div> <div class="parameter_description">Green component.</div>
</div> </div>
<div class="parameter_header"> <div class="parameter_header">
<span class="parameter_name">b</span> <span class="parameter_name">b</span>
<span class="type parameter_type">integer</span> <span class="type parameter_type">number</span>
</div> </div>
<div class="parameter_main"> <div class="parameter_main">
<div class="parameter_description">Blue component.</div> <div class="parameter_description">Blue component.</div>
</div> </div>
<div class="parameter_header"> <div class="parameter_header">
<span class="parameter_name">a</span> <span class="parameter_name">a</span>
<span class="type parameter_type">integer</span> <span class="type parameter_type">number</span>
</div> </div>
<div class="parameter_main"> <div class="parameter_main">
<div class="parameter_description">Alpha component.</div> <div class="parameter_description">Alpha component.</div>

View File

@ -60,28 +60,28 @@
</div> </div>
<div id="main" class="main"> <div id="main" class="main">
<h1>RGBColor</h1> <h1>RGBColor</h1>
<div class="description">RGB color object. Components are integers in the range of 0..255.</div> <div class="description">RGB color object. Components are numbers in the range of 0..255.</div>
<h2>Constructor</h2> <h2>Constructor</h2>
<div class="function_container"> <div class="function_container">
<div id="RGBColor" class="function_signature">new RGBColor (r, g, b)</div> <div id="RGBColor" class="function_signature">new RGBColor (r, g, b)</div>
<div class="function_title">Parameters</div> <div class="function_title">Parameters</div>
<div class="parameter_header"> <div class="parameter_header">
<span class="parameter_name">r</span> <span class="parameter_name">r</span>
<span class="type parameter_type">integer</span> <span class="type parameter_type">number</span>
</div> </div>
<div class="parameter_main"> <div class="parameter_main">
<div class="parameter_description">Red component.</div> <div class="parameter_description">Red component.</div>
</div> </div>
<div class="parameter_header"> <div class="parameter_header">
<span class="parameter_name">g</span> <span class="parameter_name">g</span>
<span class="type parameter_type">integer</span> <span class="type parameter_type">number</span>
</div> </div>
<div class="parameter_main"> <div class="parameter_main">
<div class="parameter_description">Green component.</div> <div class="parameter_description">Green component.</div>
</div> </div>
<div class="parameter_header"> <div class="parameter_header">
<span class="parameter_name">b</span> <span class="parameter_name">b</span>
<span class="type parameter_type">integer</span> <span class="type parameter_type">number</span>
</div> </div>
<div class="parameter_main"> <div class="parameter_main">
<div class="parameter_description">Blue component.</div> <div class="parameter_description">Blue component.</div>
@ -95,21 +95,21 @@
<div class="function_title">Parameters</div> <div class="function_title">Parameters</div>
<div class="parameter_header"> <div class="parameter_header">
<span class="parameter_name">r</span> <span class="parameter_name">r</span>
<span class="type parameter_type">integer</span> <span class="type parameter_type">number</span>
</div> </div>
<div class="parameter_main"> <div class="parameter_main">
<div class="parameter_description">Red component.</div> <div class="parameter_description">Red component.</div>
</div> </div>
<div class="parameter_header"> <div class="parameter_header">
<span class="parameter_name">g</span> <span class="parameter_name">g</span>
<span class="type parameter_type">integer</span> <span class="type parameter_type">number</span>
</div> </div>
<div class="parameter_main"> <div class="parameter_main">
<div class="parameter_description">Green component.</div> <div class="parameter_description">Green component.</div>
</div> </div>
<div class="parameter_header"> <div class="parameter_header">
<span class="parameter_name">b</span> <span class="parameter_name">b</span>
<span class="type parameter_type">integer</span> <span class="type parameter_type">number</span>
</div> </div>
<div class="parameter_main"> <div class="parameter_main">
<div class="parameter_description">Blue component.</div> <div class="parameter_description">Blue component.</div>

View File

@ -1,12 +1,12 @@
/** /**
* RGB color object. Components are integers in the range of 0..255. * RGB color object. Components are numbers in the range of 0..255.
*/ */
export class RGBColor export class RGBColor
{ {
/** /**
* @param {integer} r Red component. * @param {number} r Red component.
* @param {integer} g Green component. * @param {number} g Green component.
* @param {integer} b Blue component. * @param {number} b Blue component.
*/ */
constructor (r, g, b) constructor (r, g, b)
{ {
@ -17,9 +17,9 @@ export class RGBColor
/** /**
* Sets the value of all components. * Sets the value of all components.
* @param {integer} r Red component. * @param {number} r Red component.
* @param {integer} g Green component. * @param {number} g Green component.
* @param {integer} b Blue component. * @param {number} b Blue component.
*/ */
Set (r, g, b) Set (r, g, b)
{ {
@ -39,15 +39,15 @@ export class RGBColor
} }
/** /**
* RGBA color object. Components are integers in the range of 0..255. * RGBA color object. Components are numbers in the range of 0..255.
*/ */
export class RGBAColor export class RGBAColor
{ {
/** /**
* @param {integer} r Red component. * @param {number} r Red component.
* @param {integer} g Green component. * @param {number} g Green component.
* @param {integer} b Blue component. * @param {number} b Blue component.
* @param {integer} a Alpha component. * @param {number} a Alpha component.
*/ */
constructor (r, g, b, a) constructor (r, g, b, a)
{ {
@ -59,10 +59,10 @@ export class RGBAColor
/** /**
* Sets the value of all components. * Sets the value of all components.
* @param {integer} r Red component. * @param {number} r Red component.
* @param {integer} g Green component. * @param {number} g Green component.
* @param {integer} b Blue component. * @param {number} b Blue component.
* @param {integer} a Alpha component. * @param {number} a Alpha component.
*/ */
Set (r, g, b, a) Set (r, g, b, a)
{ {