add comments to odoo engine

src/odoo/collections/field-metadata.ts

@@ -1,6 +1,16 @@
 import { ModelMetadataCollection } from "../collections/model-metadata";
 import { OdooFieldMetadata } from "../metadata/field-metadata";
 
+/**
+ *
+ * ███████╗██╗███████╗██╗     ██████╗ ███╗   ███╗███████╗████████╗ █████╗ ██████╗  █████╗ ████████╗ █████╗  ██████╗ ██████╗ ██╗     ██╗     ███████╗ ██████╗████████╗██╗ ██████╗ ███╗   ██╗
+ * ██╔════╝██║██╔════╝██║     ██╔══██╗████╗ ████║██╔════╝╚══██╔══╝██╔══██╗██╔══██╗██╔══██╗╚══██╔══╝██╔══██╗██╔════╝██╔═══██╗██║     ██║     ██╔════╝██╔════╝╚══██╔══╝██║██╔═══██╗████╗  ██║
+ * █████╗  ██║█████╗  ██║     ██║  ██║██╔████╔██║█████╗     ██║   ███████║██║  ██║███████║   ██║   ███████║██║     ██║   ██║██║     ██║     █████╗  ██║        ██║   ██║██║   ██║██╔██╗ ██║
+ * ██╔══╝  ██║██╔══╝  ██║     ██║  ██║██║╚██╔╝██║██╔══╝     ██║   ██╔══██║██║  ██║██╔══██║   ██║   ██╔══██║██║     ██║   ██║██║     ██║     ██╔══╝  ██║        ██║   ██║██║   ██║██║╚██╗██║
+ * ██║     ██║███████╗███████╗██████╔╝██║ ╚═╝ ██║███████╗   ██║   ██║  ██║██████╔╝██║  ██║   ██║   ██║  ██║╚██████╗╚██████╔╝███████╗███████╗███████╗╚██████╗   ██║   ██║╚██████╔╝██║ ╚████║
+ * ╚═╝     ╚═╝╚══════╝╚══════╝╚═════╝ ╚═╝     ╚═╝╚══════╝   ╚═╝   ╚═╝  ╚═╝╚═════╝ ╚═╝  ╚═╝   ╚═╝   ╚═╝  ╚═╝ ╚═════╝ ╚═════╝ ╚══════╝╚══════╝╚══════╝ ╚═════╝   ╚═╝   ╚═╝ ╚═════╝ ╚═╝  ╚═══╝
+ *                                                                                                                                                                                     
+ */
 export class FieldMetadataCollection<T extends { target?: Function | string, propertyName?: string }> extends ModelMetadataCollection<T> {
 
     /**

src/odoo/collections/model-metadata.ts

@@ -1,3 +1,13 @@
+/**
+ *
+ * ███╗   ███╗ ██████╗ ██████╗ ███████╗██╗     ███╗   ███╗███████╗████████╗ █████╗ ██████╗  █████╗ ████████╗ █████╗  ██████╗ ██████╗ ██╗     ██╗     ███████╗ ██████╗████████╗██╗ ██████╗ ███╗   ██╗
+ * ████╗ ████║██╔═══██╗██╔══██╗██╔════╝██║     ████╗ ████║██╔════╝╚══██╔══╝██╔══██╗██╔══██╗██╔══██╗╚══██╔══╝██╔══██╗██╔════╝██╔═══██╗██║     ██║     ██╔════╝██╔════╝╚══██╔══╝██║██╔═══██╗████╗  ██║
+ * ██╔████╔██║██║   ██║██║  ██║█████╗  ██║     ██╔████╔██║█████╗     ██║   ███████║██║  ██║███████║   ██║   ███████║██║     ██║   ██║██║     ██║     █████╗  ██║        ██║   ██║██║   ██║██╔██╗ ██║
+ * ██║╚██╔╝██║██║   ██║██║  ██║██╔══╝  ██║     ██║╚██╔╝██║██╔══╝     ██║   ██╔══██║██║  ██║██╔══██║   ██║   ██╔══██║██║     ██║   ██║██║     ██║     ██╔══╝  ██║        ██║   ██║██║   ██║██║╚██╗██║
+ * ██║ ╚═╝ ██║╚██████╔╝██████╔╝███████╗███████╗██║ ╚═╝ ██║███████╗   ██║   ██║  ██║██████╔╝██║  ██║   ██║   ██║  ██║╚██████╗╚██████╔╝███████╗███████╗███████╗╚██████╗   ██║   ██║╚██████╔╝██║ ╚████║
+ * ╚═╝     ╚═╝ ╚═════╝ ╚═════╝ ╚══════╝╚══════╝╚═╝     ╚═╝╚══════╝   ╚═╝   ╚═╝  ╚═╝╚═════╝ ╚═╝  ╚═╝   ╚═╝   ╚═╝  ╚═╝ ╚═════╝ ╚═════╝ ╚══════╝╚══════╝╚══════╝ ╚═════╝   ╚═╝   ╚═╝ ╚═════╝ ╚═╝  ╚═══╝
+ *                                                                                                                                                                                                
+ */
 export class ModelMetadataCollection<T extends { target?: Function | string }> {
 
     protected items: T[] = [];

src/odoo/metadata/field-metadata.ts

@@ -1,5 +1,15 @@
 import { FieldOptions  } from "../options/field-options";
 
+/**
+ *  ██████╗ ██████╗  ██████╗  ██████╗ ███████╗██╗███████╗██╗     ██████╗ ███╗   ███╗███████╗████████╗ █████╗ ██████╗  █████╗ ████████╗ █████╗ 
+ * ██╔═══██╗██╔══██╗██╔═══██╗██╔═══██╗██╔════╝██║██╔════╝██║     ██╔══██╗████╗ ████║██╔════╝╚══██╔══╝██╔══██╗██╔══██╗██╔══██╗╚══██╔══╝██╔══██╗
+ * ██║   ██║██║  ██║██║   ██║██║   ██║█████╗  ██║█████╗  ██║     ██║  ██║██╔████╔██║█████╗     ██║   ███████║██║  ██║███████║   ██║   ███████║
+ * ██║   ██║██║  ██║██║   ██║██║   ██║██╔══╝  ██║██╔══╝  ██║     ██║  ██║██║╚██╔╝██║██╔══╝     ██║   ██╔══██║██║  ██║██╔══██║   ██║   ██╔══██║
+ * ╚██████╔╝██████╔╝╚██████╔╝╚██████╔╝██║     ██║███████╗███████╗██████╔╝██║ ╚═╝ ██║███████╗   ██║   ██║  ██║██████╔╝██║  ██║   ██║   ██║  ██║
+ * ╚═════╝ ╚═════╝  ╚═════╝  ╚═════╝ ╚═╝     ╚═╝╚══════╝╚══════╝╚═════╝ ╚═╝     ╚═╝╚══════╝   ╚═╝   ╚═╝  ╚═╝╚═════╝ ╚═╝  ╚═╝   ╚═╝   ╚═╝  ╚═╝
+ *
+ * Representa los metadatos de propiedades de un modelo
+ */
 export interface OdooFieldMetadata {
 
     readonly target: Function | string;

src/odoo/metadata/metadata-storage.ts

@@ -3,6 +3,17 @@ import { FieldMetadataCollection } from "../collections/field-metadata";
 import { OdooModelMetadata } from "./model-metadata";
 import { OdooFieldMetadata } from "./field-metadata";
 
+/**
+ *
+ * ███╗   ███╗███████╗████████╗ █████╗ ██████╗  █████╗ ████████╗ █████╗ ███████╗████████╗ ██████╗ ██████╗  █████╗  ██████╗ ███████╗
+ * ████╗ ████║██╔════╝╚══██╔══╝██╔══██╗██╔══██╗██╔══██╗╚══██╔══╝██╔══██╗██╔════╝╚══██╔══╝██╔═══██╗██╔══██╗██╔══██╗██╔════╝ ██╔════╝
+ * ██╔████╔██║█████╗     ██║   ███████║██║  ██║███████║   ██║   ███████║███████╗   ██║   ██║   ██║██████╔╝███████║██║  ███╗█████╗  
+ * ██║╚██╔╝██║██╔══╝     ██║   ██╔══██║██║  ██║██╔══██║   ██║   ██╔══██║╚════██║   ██║   ██║   ██║██╔══██╗██╔══██║██║   ██║██╔══╝  
+ * ██║ ╚═╝ ██║███████╗   ██║   ██║  ██║██████╔╝██║  ██║   ██║   ██║  ██║███████║   ██║   ╚██████╔╝██║  ██║██║  ██║╚██████╔╝███████╗
+ * ╚═╝     ╚═╝╚══════╝   ╚═╝   ╚═╝  ╚═╝╚═════╝ ╚═╝  ╚═╝   ╚═╝   ╚═╝  ╚═╝╚══════╝   ╚═╝    ╚═════╝ ╚═╝  ╚═╝╚═╝  ╚═╝ ╚═════╝ ╚══════╝
+ *
+ * Representa el repositorio de metadatos
+ */
 export class MetadataStorage {
 
     readonly models = new ModelMetadataCollection<OdooModelMetadata>();

src/odoo/metadata/model-metadata.ts

@@ -1,3 +1,13 @@
+/**
+ *  ██████╗ ██████╗  ██████╗  ██████╗ ███╗   ███╗ ██████╗ ██████╗ ███████╗██╗     ███╗   ███╗███████╗████████╗ █████╗ ██████╗  █████╗ ████████╗ █████╗ 
+ * ██╔═══██╗██╔══██╗██╔═══██╗██╔═══██╗████╗ ████║██╔═══██╗██╔══██╗██╔════╝██║     ████╗ ████║██╔════╝╚══██╔══╝██╔══██╗██╔══██╗██╔══██╗╚══██╔══╝██╔══██╗
+ * ██║   ██║██║  ██║██║   ██║██║   ██║██╔████╔██║██║   ██║██║  ██║█████╗  ██║     ██╔████╔██║█████╗     ██║   ███████║██║  ██║███████║   ██║   ███████║
+ * ██║   ██║██║  ██║██║   ██║██║   ██║██║╚██╔╝██║██║   ██║██║  ██║██╔══╝  ██║     ██║╚██╔╝██║██╔══╝     ██║   ██╔══██║██║  ██║██╔══██║   ██║   ██╔══██║
+ * ╚██████╔╝██████╔╝╚██████╔╝╚██████╔╝██║ ╚═╝ ██║╚██████╔╝██████╔╝███████╗███████╗██║ ╚═╝ ██║███████╗   ██║   ██║  ██║██████╔╝██║  ██║   ██║   ██║  ██║
+ * ╚═════╝ ╚═════╝  ╚═════╝  ╚═════╝ ╚═╝     ╚═╝ ╚═════╝ ╚═════╝ ╚══════╝╚══════╝╚═╝     ╚═╝╚══════╝   ╚═╝   ╚═╝  ╚═╝╚═════╝ ╚═╝  ╚═╝   ╚═╝   ╚═╝  ╚═╝
+ *
+ * Representa los metadatos de la clase del modelo
+ */
 export interface OdooModelMetadata {
 
     readonly target: Function | string;

src/odoo/options/field-options.ts

@@ -1,5 +1,17 @@
 import { FieldType } from "../types/field";
 
+/**
+ *
+ * ███████╗██╗███████╗██╗     ██████╗  ██████╗ ██████╗ ████████╗██╗ ██████╗ ███╗   ██╗███████╗
+ * ██╔════╝██║██╔════╝██║     ██╔══██╗██╔═══██╗██╔══██╗╚══██╔══╝██║██╔═══██╗████╗  ██║██╔════╝
+ * █████╗  ██║█████╗  ██║     ██║  ██║██║   ██║██████╔╝   ██║   ██║██║   ██║██╔██╗ ██║███████╗
+ * ██╔══╝  ██║██╔══╝  ██║     ██║  ██║██║   ██║██╔═══╝    ██║   ██║██║   ██║██║╚██╗██║╚════██║
+ * ██║     ██║███████╗███████╗██████╔╝╚██████╔╝██║        ██║   ██║╚██████╔╝██║ ╚████║███████║
+ * ╚═╝     ╚═╝╚══════╝╚══════╝╚═════╝  ╚═════╝ ╚═╝        ╚═╝   ╚═╝ ╚═════╝ ╚═╝  ╚═══╝╚══════╝
+ *
+ * Opciones posibles para los tipos de datos de los modelos
+ *
+ */
 export class FieldOptions {
 
     readonly name?: string;

src/odoo/types/field.ts

@@ -1,5 +1,17 @@
 export type FieldType = "char"|"text"|"html"|"date"|"datetime"|"integer"|"float"|"boolean"|"binary"|"selection"|"one2many"|"many2one"|"many2many";
 
+/**
+ *
+ * ███████╗██╗███████╗██╗     ██████╗ ████████╗██╗   ██╗██████╗ ███████╗███████╗
+ * ██╔════╝██║██╔════╝██║     ██╔══██╗╚══██╔══╝╚██╗ ██╔╝██╔══██╗██╔════╝██╔════╝
+ * █████╗  ██║█████╗  ██║     ██║  ██║   ██║    ╚████╔╝ ██████╔╝█████╗  ███████╗
+ * ██╔══╝  ██║██╔══╝  ██║     ██║  ██║   ██║     ╚██╔╝  ██╔═══╝ ██╔══╝  ╚════██║
+ * ██║     ██║███████╗███████╗██████╔╝   ██║      ██║   ██║     ███████╗███████║
+ * ╚═╝     ╚═╝╚══════╝╚══════╝╚═════╝    ╚═╝      ╚═╝   ╚═╝     ╚══════╝╚══════╝
+ *
+ * Tipos de datos que se pueden asignar a los modelos
+ *
+ */
 export abstract class FieldTypes {
 
     static CHAR: FieldType = "char";

src/odoo/utils/import-models.ts

@@ -21,11 +21,19 @@ import { StockLocation } from "../models/stock.location";
 
 /**
  *
+ * ██╗███╗   ███╗██████╗  ██████╗ ██████╗ ████████╗███╗   ███╗ ██████╗ ██████╗ ███████╗██╗     ███████╗
+ * ██║████╗ ████║██╔══██╗██╔═══██╗██╔══██╗╚══██╔══╝████╗ ████║██╔═══██╗██╔══██╗██╔════╝██║     ██╔════╝
+ * ██║██╔████╔██║██████╔╝██║   ██║██████╔╝   ██║   ██╔████╔██║██║   ██║██║  ██║█████╗  ██║     ███████╗
+ * ██║██║╚██╔╝██║██╔═══╝ ██║   ██║██╔══██╗   ██║   ██║╚██╔╝██║██║   ██║██║  ██║██╔══╝  ██║     ╚════██║
+ * ██║██║ ╚═╝ ██║██║     ╚██████╔╝██║  ██║   ██║   ██║ ╚═╝ ██║╚██████╔╝██████╔╝███████╗███████╗███████║
+ * ╚═╝╚═╝     ╚═╝╚═╝      ╚═════╝ ╚═╝  ╚═╝   ╚═╝   ╚═╝     ╚═╝ ╚═════╝ ╚═════╝ ╚══════╝╚══════╝╚══════╝
+ *
+ * Función que se encarga de cargar los modelos proporcionados al motor de reflectividad de clases
+ * y por consiguiente extrae sus propiedades para luego definirlos en una registro temporal de metadatos
  */
 export function importModels(): void {
     const models: Function[] = [];
 
-    // Add classes to register to metadata storage
     models.push(
         AccountTax,
         AccountTaxCode,

src/odoo/utils/metadata-storage.ts

@@ -2,6 +2,14 @@ import { MetadataStorage } from "../metadata/metadata-storage";
 
 /**
  *
+ *  ██████╗ ███████╗████████╗███╗   ███╗███████╗████████╗ █████╗ ██████╗  █████╗ ████████╗ █████╗ ███████╗████████╗ ██████╗ ██████╗  █████╗  ██████╗ ███████╗
+ * ██╔════╝ ██╔════╝╚══██╔══╝████╗ ████║██╔════╝╚══██╔══╝██╔══██╗██╔══██╗██╔══██╗╚══██╔══╝██╔══██╗██╔════╝╚══██╔══╝██╔═══██╗██╔══██╗██╔══██╗██╔════╝ ██╔════╝
+ * ██║  ███╗█████╗     ██║   ██╔████╔██║█████╗     ██║   ███████║██║  ██║███████║   ██║   ███████║███████╗   ██║   ██║   ██║██████╔╝███████║██║  ███╗█████╗  
+ * ██║   ██║██╔══╝     ██║   ██║╚██╔╝██║██╔══╝     ██║   ██╔══██║██║  ██║██╔══██║   ██║   ██╔══██║╚════██║   ██║   ██║   ██║██╔══██╗██╔══██║██║   ██║██╔══╝  
+ * ╚██████╔╝███████╗   ██║   ██║ ╚═╝ ██║███████╗   ██║   ██║  ██║██████╔╝██║  ██║   ██║   ██║  ██║███████║   ██║   ╚██████╔╝██║  ██║██║  ██║╚██████╔╝███████╗
+ * ╚═════╝ ╚══════╝   ╚═╝   ╚═╝     ╚═╝╚══════╝   ╚═╝   ╚═╝  ╚═╝╚═════╝ ╚═╝  ╚═╝   ╚═╝   ╚═╝  ╚═╝╚══════╝   ╚═╝    ╚═════╝ ╚═╝  ╚═╝╚═╝  ╚═╝ ╚═════╝ ╚══════╝
+ *
+ * Registro temporal de metadatos de los modelos
  */
 export function getMetadataStorage(): MetadataStorage {
     const globalScope: any = global;