js doc composer for interop with visual paradigm

2024-11-27 09:05:37 +02:00
parent c2245d92b3
commit 54b8941f3c
9 changed files with 186 additions and 30 deletions
@@ -1,4 +1,8 @@
 import path from 'path'
+
+/**
+ * Configuration class
+ */
 class Config{
    name = 'config';

@@ -9,15 +13,35 @@ class Config{
        name:'pronature',
        url: "mongodb://127.0.0.1:27017/pronature"
    }
+
+    /**
+     * @class web site options 
+     * @alias SiteOptions
+     * @memberof Config
+     */
    site = {
+        /** Host name 
+         * @type {string} 
+         * @memberof SiteOptions
+         */
        host:'https://localhost:5173',
        ssl: true,
        port: 3000,
+        /** 
+         * @class certificate data
+         * @alias CertificateOptions
+         * @memberof SiteOptions
+         */
        certificate: {
+            /** 
+             * Certificate key 
+             * @type {string}
+             * @memberof CertificateOptions
+             */
            key: './.cert/dev-key.pem',
            cert: './.cert/dev-cert.pem',
            passphrase: 'parola'
-        }
+        },
    }
    am = { 
        salt : 'P@ssSal7y!!',