Close #6

src/structure/rectangular_structure.ts

@@ -4,6 +4,9 @@ import { Structure } from "./structure";
 
 export { RectangularStructureParams };
 
+/**
+ * Classe mère pour toutes les structures ayant une base rectangulaire (vannes, seuils)
+ */
 export abstract class RectangularStructure extends Structure {
 
     constructor(prms: RectangularStructureParams, dbg: boolean = false) {

src/structure/structure_cem88d.ts

@@ -11,7 +11,7 @@ export { RectangularStructureParams };
 export class StructureCem88d extends RectangularStructure {
 
     /**
-     * Calcul analytique Q = f(Cd, L, h1, h2, W)
+     * Calcul analytique Q = f(Cd, L, h1, h2, W) CEM88D
      * @param sVarCalc Variable à calculer (doit être "Q")
      */
     public Equation(sVarCalc: string): Result {

src/structure/structure_cem88v.ts

@@ -11,7 +11,7 @@ export { RectangularStructureParams };
 export class StructureCem88v extends RectangularStructure {
 
     /**
-     * Calcul analytique Q = f(Cd, L, h1, h2, W)
+     * Calcul analytique Q = f(Cd, L, h1, h2, W) CEM88V
      * @param sVarCalc Variable à calculer (doit être "Q")
      */
     public Equation(sVarCalc: string): Result {

src/structure/structure_cunge80.ts

@@ -6,11 +6,11 @@ import { Structure, StructureFlowMode, StructureFlowRegime } from "./structure";
 export { RectangularStructureParams };
 
 /**
- * Equation classique orifice noyé
+ * Equation Cunge80
  */
 export class StructureCunge80 extends RectangularStructure {
     /**
-     * Calcul du débit avec l'équation classique d'un orifice noyé
+     * Calcul du débit avec l'équation Cunge80
      * @param sVarCalc Variable à calculer (doit être égale à Q ici)
      */
     public Equation(sVarCalc: string): Result {

src/structure/structure_weir_free.ts

@@ -9,6 +9,10 @@ export { RectangularStructureParams };
  * Equation classique seuil dénoyé
  */
 export class StructureWeirFree extends RectangularStructure {
+    /**
+     * Calcul analytique Q = f(Cd, L, h1, h2, W) seuil dénoyé
+     * @param sVarCalc Variable à calculer (doit être "Q")
+     */
     public Equation(sVarCalc: string): Result {
         const res: Result = super.Equation(sVarCalc);
         // TODO : Warning si les conditions hydrauliques ne correspondent pas à un seuil dénoyé