Fix: Mismatched JSDoc and function signature

jhipster · Jan 3, 2025 · 7d46da3 · 7d46da3
1 parent c8eec34
commit 7d46da3
Show file tree

Hide file tree

Showing 6 changed files with 1 addition and 10 deletions.
diff --git a/generators/base-core/generator.ts b/generators/base-core/generator.ts
@@ -750,7 +750,6 @@ You can ignore this error by passing '--skip-checks' to jhipster command.`);
 
   /**
    * Remove File
-   * @param file
    */
   removeFile(...path: string[]) {
     const destinationFile = this.destinationPath(...path);

diff --git a/generators/base-workspaces/internal/docker-prompts.ts b/generators/base-workspaces/internal/docker-prompts.ts
@@ -368,7 +368,7 @@ async function askForDockerPushCommand() {
 
 /**
  * Get App Folders
- * @param input path to join to destination path
+ * @param directory path to join to destination path
  * @param deploymentApplicationType type of application being composed
  * @returns {Array} array of string representing app folders
  */

diff --git a/generators/react/generator.ts b/generators/react/generator.ts
@@ -282,10 +282,6 @@ export default class ReactGenerator extends BaseApplicationGenerator {
    * @param {string} entityFolderName - Entity Folder Name
    * @param {string} entityFileName - Entity File Name
    * @param {string} entityUrl - Entity router URL
-   * @param {string} clientFramework - The name of the client framework
-   * @param {string} microserviceName - Microservice Name
-   * @param {boolean} readOnly - If the entity is read-only or not
-   * @param {string} pageTitle - The translation key or the text for the page title in the browser
    */
   addEntityToModule(
     entityInstance,

diff --git a/generators/vue/generator.ts b/generators/vue/generator.ts
@@ -330,7 +330,6 @@ export default class VueGenerator extends BaseApplicationGenerator {
    *
    * @param {string} routerName - The name of the Angular router (which by default is the name of the entity).
    * @param {boolean} enableTranslation - If translations are enabled or not
-   * @param {string} clientFramework - The name of the client framework
    * @param {string} entityTranslationKeyMenu - i18n key for entity entry in menu
    * @param {string} entityTranslationValue - i18n value for entity entry in menu
    */
@@ -355,7 +354,6 @@ export default class VueGenerator extends BaseApplicationGenerator {
    * @param {string} entityUrl - Entity router URL
    * @param {string} microserviceName - Microservice Name
    * @param {boolean} readOnly - If the entity is read-only or not
-   * @param {string} pageTitle - The translation key or the text for the page title in the browser
    */
   addEntityToModule(entityInstance, entityClass, entityName, entityFolderName, entityFileName, _entityUrl, _microserviceName, readOnly?) {
     this.needleApi.clientVue.addEntityToRouterImport(entityName, entityFileName, entityFolderName, readOnly);

diff --git a/lib/jdl/converters/validators/jdl-with-application-validator.ts b/lib/jdl/converters/validators/jdl-with-application-validator.ts
@@ -42,7 +42,6 @@ const { BLUEPRINTS, BASE_NAME } = OptionNames;
  * Constructor taking the jdl object to check against application settings.
  * @param {JDLObject} jdlObject -  the jdl object to check.
  * @param {Object} logger - the logger to use, default to the console.
- * @param {Object} [options]
  */
 export default function createValidator(jdlObject: JDLObject, logger: any = console) {
   if (!jdlObject) {

diff --git a/lib/jdl/converters/validators/jdl-without-application-validator.ts b/lib/jdl/converters/validators/jdl-without-application-validator.ts
@@ -47,7 +47,6 @@ const { SQL } = databaseTypes;
  * @param {String} applicationSettings.databaseType - the DB type.
  * @param {Array} applicationSettings.blueprints - the blueprints used.
  * @param {Object} [logger] - the logger to use, default to the console.
- * @param {Object} [options]
  */
 export default function createValidator(jdlObject: JDLObject, applicationSettings: any = {}, logger: any = console) {
   if (!jdlObject) {