From f3b71460341eb6e7c266bf193599e0c0e77f292f Mon Sep 17 00:00:00 2001 From: Matthias Koefferlein Date: Sat, 28 Feb 2026 09:48:54 +0100 Subject: [PATCH] Added documentation to clarify constraints on the documentation parameter name --- src/lay/lay/gsiDeclLayApplication.cc | 5 ++++- src/laybasic/laybasic/gsiDeclLayDispatcher.cc | 3 +++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/src/lay/lay/gsiDeclLayApplication.cc b/src/lay/lay/gsiDeclLayApplication.cc index dde5d8aac..f5ca372d3 100644 --- a/src/lay/lay/gsiDeclLayApplication.cc +++ b/src/lay/lay/gsiDeclLayApplication.cc @@ -141,13 +141,16 @@ static gsi::Methods application_methods () "@param name The name of the configuration parameter to set\n" "@param value The value to which to set the configuration parameter\n" "\n" + "The configuration parameter name needs to be a valid XML element name. Otherwise, a corrupt " + "configuration file will be produced.\n" + "\n" "This method sets the configuration parameter with the given name to the given value. " "Values can only be strings. Numerical values have to be converted into strings first. " "The actual format of the value depends on the configuration parameter. The name must " "be one of the names returned by \\get_config_names." "\n" "It is possible to write an arbitrary name/value pair into the configuration database which then is " - "written to the configuration file." + "written to the configuration file.\n" ) + // TODO: basically this method belongs to Dispatcher (aka MainWindow). // There is separate declaration for Dispatcher which we have to synchronize diff --git a/src/laybasic/laybasic/gsiDeclLayDispatcher.cc b/src/laybasic/laybasic/gsiDeclLayDispatcher.cc index e5ae50228..b005437a3 100644 --- a/src/laybasic/laybasic/gsiDeclLayDispatcher.cc +++ b/src/laybasic/laybasic/gsiDeclLayDispatcher.cc @@ -101,6 +101,9 @@ Class decl_Dispatcher ("lay", "Dispatcher", "@param name The name of the configuration parameter to set\n" "@param value The value to which to set the configuration parameter\n" "\n" + "The configuration parameter name needs to be a valid XML element name. Otherwise, a corrupt " + "configuration file will be produced.\n" + "\n" "This method sets a configuration parameter with the given name to the given value. " "Values can only be strings. Numerical values have to be converted into strings first. " "Local configuration parameters override global configurations for this specific view. "