Merge pull request #2181 from guwirth/td-3

improve config description

Author: guwirth

cxx-sensors/src/main/java/org/sonar/cxx/sensors/other/CxxOtherRepository.java

@@ -70,7 +70,8 @@ public void define(Context context) {
           // errors are critical and can cause that the server cannot be started anymore.
           var xml = ruleDefs.substring(0, Math.min(ruleDefs.length(), 120))
             .replaceAll("\\R", "").replaceAll(">[ ]+<", "><");
-          LOG.error("Cannot load rule definions for 'sonar.cxx.other.rules', '{}', XML '{}...'", e.getMessage(), xml);
+          LOG.error("Cannot load rule definions for 'sonar.cxx.other.rules', '{}', XML '{}...', skipping",
+                    e.getMessage(), xml);
         }
       }
     }

cxx-sensors/src/main/java/org/sonar/cxx/sensors/other/CxxOtherSensor.java

@@ -55,6 +55,7 @@ public static List<PropertyDefinition> properties() {
         .description(
           "Comma-separated paths (absolute or relative to the project base directory) to `*.xml` files with"
             + " `other` issues. Ant patterns are accepted for relative paths."
+            + " In the SonarQube UI, enter one entry per field."
         )
         .category("CXX External Analyzers")
         .subCategory(subcategory)

cxx-sensors/src/main/java/org/sonar/cxx/sensors/pclint/CxxPCLintSensor.java

@@ -70,6 +70,7 @@ public static List<PropertyDefinition> properties() {
         .description(
           "Comma-separated paths (absolute or relative to the project base directory) to `*.xml` files with"
             + " `PC-lint` issues. Ant patterns are accepted for relative paths."
+            + " In the SonarQube UI, enter one entry per field."
         )
         .category("CXX External Analyzers")
         .subCategory("PC-lint")

cxx-sensors/src/main/java/org/sonar/cxx/sensors/rats/CxxRatsSensor.java

@@ -56,6 +56,7 @@ public static List<PropertyDefinition> properties() {
         .description(
           "Comma-separated paths (absolute or relative to the project base directory) to `*.xml` files with"
             + " `RATS` issues. Ant patterns are accepted for relative paths."
+            + " In the SonarQube UI, enter one entry per field."
         )
         .category("CXX External Analyzers")
         .subCategory("RATS")

cxx-sensors/src/main/java/org/sonar/cxx/sensors/tests/dotnet/CxxUnitTestResultsImportSensor.java

@@ -57,6 +57,7 @@ public static List<PropertyDefinition> properties() {
           "Paths to VSTest reports. Multiple paths may be comma-delimited, or included via wildcards."
             + " Note that while measures such as the number of tests are displayed at project level, no drilldown"
             + " is available."
+            + " In the SonarQube UI, enter one entry per field."
         )
         .category(category)
         .subCategory("Visual C++")
@@ -69,6 +70,7 @@ public static List<PropertyDefinition> properties() {
           "Paths to NUnit execution reports. Multiple paths may be comma-delimited, or included via wildcards."
             + " Note that while measures such as the number of tests are displayed at project level, no drilldown"
             + " is available."
+            + " In the SonarQube UI, enter one entry per field."
         )
         .category(category)
         .subCategory("NUnit")

cxx-sensors/src/main/java/org/sonar/cxx/sensors/tests/xunit/CxxXunitSensor.java

@@ -58,6 +58,7 @@ public static List<PropertyDefinition> properties() {
             + " Each path may be absolute or relative to the project base directory. Ant patterns are accepted for"
             + " relative paths. Note that while measures such as the number of tests are displayed at project level,"
             + " no drilldown is available."
+            + " In the SonarQube UI, enter one entry per field."
         )
         .category("CXX External Analyzers")
         .subCategory("xUnit")

cxx-sensors/src/main/java/org/sonar/cxx/sensors/valgrind/CxxValgrindSensor.java

@@ -51,6 +51,7 @@ public static List<PropertyDefinition> properties() {
         .description(
           "Comma-separated paths (absolute or relative to the project base directory) to `*.xml` files with"
             + " `Valgrind` issues. Ant patterns are accepted for relative paths."
+            + " In the SonarQube UI, enter one entry per field."
         )
         .category("CXX External Analyzers")
         .subCategory("Valgrind")

cxx-sensors/src/main/java/org/sonar/cxx/sensors/veraxx/CxxVeraxxSensor.java

@@ -52,6 +52,7 @@ public static List<PropertyDefinition> properties() {
         .description(
           "Comma-separated paths (absolute or relative to the project base directory) to `*.xml` files with"
             + " `Vera++` issues. Ant patterns are accepted for relative paths."
+            + " In the SonarQube UI, enter one entry per field."
         )
         .category("CXX External Analyzers")
         .subCategory("Vera++")

sonar-cxx-plugin/src/main/java/org/sonar/plugins/cxx/CxxLanguage.java

@@ -72,7 +72,7 @@ public static List<PropertyDefinition> properties() {
         .multiValues(true)
         .description(
           "List of suffixes for files to analyze (e.g. `.cxx,.cpp,.cc,.c,.hxx,.hpp,.hh,.h`)."
-            + " In the SonarQube UI, enter the file suffixes into the fields one by one."
+            + " In the SonarQube UI, enter one file suffixe per field."
             + " To turn off the CXX language, set the first entry to `-`."
         )
         .category("CXX")

sonar-cxx-plugin/src/main/java/org/sonar/plugins/cxx/CxxSquidSensor.java

@@ -123,6 +123,7 @@ public static List<PropertyDefinition> properties() {
         .description(
           "Comma-separated list of directories where the preprocessor looks for include files."
             + " The path may be either absolute or relative to the project base directory."
+            + " In the SonarQube UI, enter one entry per field."
         )
         .category("CXX")
         .subCategory("(2) Preprocessor")
@@ -139,6 +140,7 @@ public static List<PropertyDefinition> properties() {
             + " on the first line of every source file. If you add multiple files they are included in the order they"
             + " are listed from left to right. The path may be either absolute or relative to the"
             + " project base directory."
+            + " In the SonarQube UI, enter one entry per field."
         )
         .onQualifiers(Qualifiers.PROJECT)
         .build(),
@@ -171,6 +173,7 @@ public static List<PropertyDefinition> properties() {
           "Read one ore more MSBuild .LOG files to automatically extract the required macros `sonar.cxx.defines`"
             + " and include directories `sonar.cxx.includeDirectories`. The path may be either absolute or relative"
             + " to the project base directory."
+            + " In the SonarQube UI, enter one entry per field."
         )
         .category("CXX")
         .subCategory("(2) Preprocessor")
@@ -200,10 +203,11 @@ public static List<PropertyDefinition> properties() {
         .build(),
       PropertyDefinition.builder(CxxPublicApiVisitor.API_FILE_SUFFIXES_KEY)
         .defaultValue(CxxPublicApiVisitor.API_DEFAULT_FILE_SUFFIXES)
-        .name("Pulic API File suffixes")
+        .name("Public API File suffixes")
         .multiValues(true)
         .description(
           "Comma-separated list of suffixes for files to be searched for API comments and to create API metrics."
+            + " In the SonarQube UI, enter one entry per field."
         )
         .category("CXX")
         .subCategory("(3) Metrics")