docs: add some comments about function and its parameters

EscapedGibbon · EscapedGibbon · commit 0af6d0ae79cb · 2023-04-25T10:41:55.000+02:00
diff --git a/src/roi/properties/getEllipse.ts b/src/roi/properties/getEllipse.ts
@@ -17,9 +17,11 @@ export interface Ellipse {
   surface: number;
 }
 /**
+ *Calculates ellipse on around ROI
  *
- * @param roi
- * @param scale
+ * @param roi - region of interest
+ * @param scale - the multiplier to match the surface of ellipse with the surface of ROI
+ * @returns Ellipse
  */
 export function getEllipse(roi: Roi, scale: number): Ellipse {
   const nbSD = 2;

Original file line number	Diff line number	Diff line change
`@@ -17,9 +17,11 @@ export interface Ellipse {`
`17`	`17`	`surface: number;`
`18`	`18`	`}`
`19`	`19`	`/**`
	`20`	`+ *Calculates ellipse on around ROI`
`20`	`21`	`*`
`21`		`- * @param roi`
`22`		`- * @param scale`
	`22`	`+ * @param roi - region of interest`
	`23`	`+ * @param scale - the multiplier to match the surface of ellipse with the surface of ROI`
	`24`	`+ * @returns Ellipse`
`23`	`25`	`*/`
`24`	`26`	`export function getEllipse(roi: Roi, scale: number): Ellipse {`
`25`	`27`	`const nbSD = 2;`