devonfw#758: implemented requested changes

added missing Javadoc to StatusCommandlet and updated help output
leonrohne27 · Nov 18, 2024 · 3ae5e7b · 3ae5e7b
1 parent 1c4ac12
commit 3ae5e7b
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 8 deletions.
diff --git a/cli/src/main/java/com/devonfw/tools/ide/commandlet/StatusCommandlet.java b/cli/src/main/java/com/devonfw/tools/ide/commandlet/StatusCommandlet.java
@@ -1,13 +1,12 @@
 package com.devonfw.tools.ide.commandlet;
 
 import com.devonfw.tools.ide.context.IdeContext;
-import com.devonfw.tools.ide.property.CommandletProperty;
-
 
+/**
+ * {@link Commandlet} to print a status report about IDEasy.
+ */
 public class StatusCommandlet extends Commandlet {
 
-  public final CommandletProperty commandlet;
-
   /**
    * The constructor.
    *
@@ -17,7 +16,6 @@ public StatusCommandlet(IdeContext context) {
 
     super(context);
     addKeyword(getName());
-    this.commandlet = add(new CommandletProperty("", false, "commandlet"));
   }
 
   @Override

diff --git a/cli/src/main/resources/nls/Help.properties b/cli/src/main/resources/nls/Help.properties
@@ -95,8 +95,8 @@ cmd.shell.detail=The interactive shell offers console users a new user experienc
 cmd.sonar=Tool commandlet for SonarQube.
 cmd.sonar.detail=SonarQube is a platform for continuous inspection of code quality. Detailed documentation can be found at https://docs.sonarqube.org/
 cmd.sonar.val.command=Action to perform (START|STOP|ANALYZE)
-cmd.status=Checks your IDE-status
-cmd.status.detail=To check your IDE-status, you need to run the following command: 'ide status'.
+cmd.status=Prints the status report about your IDEasy.
+cmd.status.detail=To check your IDE-status (e.g. duplicated or legacy variables) as well as potential information about updates to settings you should apply\nwith ide update, run the following command: 'ide status'.
 cmd.terraform=Tool commandlet for Terraform.
 cmd.terraform.detail=Terraform is an infrastructure as code tool for managing cloud resources. Detailed documentation can be found at https://www.terraform.io/docs/index.html
 cmd.tomcat=Tool commandlet for Tomcat

diff --git a/cli/src/main/resources/nls/Help_de.properties b/cli/src/main/resources/nls/Help_de.properties
@@ -96,7 +96,7 @@ cmd.sonar=Werkzeug Kommando für SonarQube.
 cmd.sonar.detail=SonarQube ist eine Plattform für die kontinuierliche Code-Qualitätsprüfung. Detaillierte Dokumentation ist zu finden unter https://docs.sonarqube.org/
 cmd.sonar.val.command=Auszuführende Aktion (START|STOP|ANALYZE)
 cmd.status=Checkt deinen IDE-Status
-cmd.status.detail=Um deinen IDE-Status zu checken, geben sie einfach 'ide status' in die Konsole ein.
+cmd.status.detail=Um den Status Ihrer IDE zu überprüfen (z.B. doppelte oder veraltete Variablen) sowie potenzielle Informationen über Updates zu den Einstellungen,\ndie Sie mit dem Befehl 'ide update' anwenden sollten, führen Sie den folgenden Befehl aus: 'ide status'.
 cmd.terraform=Werkzeug Kommando für Terraform.
 cmd.terraform.detail=Terraform ist ein Tool für Infrastructure as Code zur Verwaltung von Cloud-Ressourcen. Detaillierte Dokumentation ist zu finden unter https://www.terraform.io/docs/index.html
 cmd.tomcat=Werkzeug Kommando für Tomcat