(openwebbeans-meecrowave) 01/02: clarify configuration mechanism in JavaDoc

[st...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

asf-gitbox-commits pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/openwebbeans-meecrowave.git

commit eae4d1ce4350921b74a1808586c50cb43ea97ea6
Author: Mark Struberg <st...@apache.org>
AuthorDate: Fri May 8 08:48:56 2026 +0200

    clarify configuration mechanism in JavaDoc
---
 .../main/java/org/apache/meecrowave/configuration/Configuration.java | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/meecrowave-core/src/main/java/org/apache/meecrowave/configuration/Configuration.java b/meecrowave-core/src/main/java/org/apache/meecrowave/configuration/Configuration.java
index e369db3..4a465ac 100644
--- a/meecrowave-core/src/main/java/org/apache/meecrowave/configuration/Configuration.java
+++ b/meecrowave-core/src/main/java/org/apache/meecrowave/configuration/Configuration.java
@@ -55,6 +55,11 @@ import org.apache.webbeans.config.PropertyLoader;
 import org.apache.xbean.recipe.ObjectRecipe;
 import org.apache.xbean.recipe.Option;
 
+/**
+ * Configuration options for Meecrowave.
+ * Always keep this in sync with the attributes configurable via the meecrowave-maven-plugin.
+ * When you start the maven plugin, all the attributes get copied over to a fresh Configuration via reflection by their names.
+ */
 public class Configuration {
     @CliOption(name = "pid-file", description = "A file path to write the process id if the server starts")
     private File pidFile;