luke
/
klayout
mirror of https://github.com/KLayout/klayout.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Added documentation to clarify constraints on the documentation parameter name

This commit is contained in:
Matthias Koefferlein 2026-02-28 09:48:54 +01:00
parent 88efda71e6
commit f3b7146034
2 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/lay/lay/gsiDeclLayApplication.cc
View File

@ -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

3
src/laybasic/laybasic/gsiDeclLayDispatcher.cc
View File

@ -101,6 +101,9 @@ Class<lay::Dispatcher> 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. "