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

eliminating some unnamed arguments

This commit is contained in:
Matthias Koefferlein 2023-12-28 21:35:14 +01:00
parent 61d99f9920
commit 11fbad0104
18 changed files with 47 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/db/db/gsiDeclDbCell.cc
View File

@ -4036,7 +4036,7 @@ Class<db::Instance> decl_Instance ("db", "Instance",
"\n"
"This const version of the \\parent_cell method has been introduced in version 0.25.\n"
) +
gsi::method_ext ("parent_cell=", &set_parent_cell_ptr,
gsi::method_ext ("parent_cell=", &set_parent_cell_ptr, gsi::arg ("new_parent"),
"@brief Moves the instance to a different cell\n"
"\n"
"Both the current and the target cell must live in the same layout.\n"
@ -4343,7 +4343,7 @@ Class<db::Instance> decl_Instance ("db", "Instance",
"@brief Gets the complex transformation of the instance or the first instance in the array\n"
"This method is always valid compared to \\trans, since simple transformations can be expressed as complex transformations as well."
) +
gsi::method_ext ("cplx_trans=", &inst_set_cplx_trans,
gsi::method_ext ("cplx_trans=", &inst_set_cplx_trans, gsi::arg ("t"),
"@brief Sets the complex transformation of the instance or the first instance in the array\n"
"\n"
"This method has been introduced in version 0.23."
@ -4352,7 +4352,7 @@ Class<db::Instance> decl_Instance ("db", "Instance",
"@brief Gets the transformation of the instance or the first instance in the array\n"
"The transformation returned is only valid if the array does not represent a complex transformation array"
) +
gsi::method_ext ("trans=", &inst_set_trans,
gsi::method_ext ("trans=", &inst_set_trans, gsi::arg ("t"),
"@brief Sets the transformation of the instance or the first instance in the array\n"
"\n"
"This method has been introduced in version 0.23."
@ -4364,7 +4364,7 @@ Class<db::Instance> decl_Instance ("db", "Instance",
"\n"
"This method has been introduced in version 0.25.\n"
) +
gsi::method_ext ("dcplx_trans=|cplx_trans=", &inst_set_dcplx_trans,
gsi::method_ext ("dcplx_trans=|cplx_trans=", &inst_set_dcplx_trans, gsi::arg ("t"),
"@brief Sets the complex transformation of the instance or the first instance in the array (in micrometer units)\n"
"This method sets the transformation the same way as \\cplx_trans=, but the displacement of this transformation is given in "
"micrometer units. It is internally translated into database units.\n"
@ -4378,7 +4378,7 @@ Class<db::Instance> decl_Instance ("db", "Instance",
"\n"
"This method has been introduced in version 0.25.\n"
) +
gsi::method_ext ("dtrans=|trans=", &inst_set_dtrans,
gsi::method_ext ("dtrans=|trans=", &inst_set_dtrans, gsi::arg ("t"),
"@brief Sets the transformation of the instance or the first instance in the array (in micrometer units)\n"
"This method sets the transformation the same way as \\cplx_trans=, but the displacement of this transformation is given in "
"micrometer units. It is internally translated into database units.\n"

2
src/db/db/gsiDeclDbEdgePair.cc
View File

@ -97,7 +97,7 @@ struct edge_pair_defs
"\n"
"Symmetric edge pairs have been introduced in version 0.27.\n"
) +
method ("symmetric=", &C::set_symmetric,
method ("symmetric=", &C::set_symmetric, gsi::arg ("flag"),
"@brief Sets a value indicating whether the edge pair is symmetric\n"
"See \\symmetric? for a description of this attribute.\n"
"\n"

2
src/db/db/gsiDeclDbGlyphs.cc
View File

@ -173,7 +173,7 @@ Class<db::TextGenerator> decl_TextGenerator ("db", "TextGenerator",
"@brief Gets the default text generator (a standard font)\n"
"This method delivers the default generator or nil if no such generator is installed."
) +
method ("set_font_paths", &db::TextGenerator::set_font_paths,
method ("set_font_paths", &db::TextGenerator::set_font_paths, gsi::arg ("paths"),
"@brief Sets the paths where to look for font files\n"
"This function sets the paths where to look for font files. After setting such a path, each font found will render a "
"specific generator. The generator can be found under the font file's name. As the text generator is also the basis "

6
src/db/db/gsiDeclDbLayoutToNetlist.cc
View File

@ -289,13 +289,13 @@ Class<db::LayoutToNetlist> decl_dbLayoutToNetlist ("db", "LayoutToNetlist",
gsi::method ("name", (const std::string &(db::LayoutToNetlist::*) () const) &db::LayoutToNetlist::name,
"@brief Gets the name of the database\n"
) +
gsi::method ("name=", &db::LayoutToNetlist::set_name,
gsi::method ("name=", &db::LayoutToNetlist::set_name, gsi::arg ("name"),
"@brief Sets the name of the database\n"
) +
gsi::method ("description", (const std::string &(db::LayoutToNetlist::*) () const) &db::LayoutToNetlist::name,
"@brief Gets the description of the database\n"
) +
gsi::method ("description=", &db::LayoutToNetlist::set_name,
gsi::method ("description=", &db::LayoutToNetlist::set_name, gsi::arg ("description"),
"@brief Sets the description of the database\n"
) +
gsi::method ("filename", &db::LayoutToNetlist::filename,
@ -306,7 +306,7 @@ Class<db::LayoutToNetlist> decl_dbLayoutToNetlist ("db", "LayoutToNetlist",
"@brief Gets the original file name of the database\n"
"The original filename is the layout file from which the netlist DB was created."
) +
gsi::method ("original_file=", &db::LayoutToNetlist::set_original_file,
gsi::method ("original_file=", &db::LayoutToNetlist::set_original_file, gsi::arg ("path"),
"@brief Sets the original file name of the database\n"
) +
gsi::method ("layer_name", (std::string (db::LayoutToNetlist::*) (const db::ShapeCollection &region) const) &db::LayoutToNetlist::name, gsi::arg ("l"),

10
src/db/db/gsiDeclDbNetlist.cc
View File

@ -276,7 +276,7 @@ Class<db::Device> decl_dbDevice (decl_dbNetlistObject, "db", "Device",
"@brief Gets the device abstract for this device instance.\n"
"See \\DeviceAbstract for more details.\n"
) +
gsi::method ("device_abstract=", &db::Device::set_device_abstract,
gsi::method ("device_abstract=", &db::Device::set_device_abstract, gsi::arg ("device_abstract"),
"@hide\n"
"Provided for test purposes mainly. Be careful with pointers!"
) +
@ -838,7 +838,7 @@ Class<db::DeviceParameterDefinition> decl_dbDeviceParameterDefinition ("db", "De
"For parameters in micrometers - for example W and L of MOS devices - this factor can be set to 1e-6 to reflect "
"the unit."
) +
gsi::method ("si_scaling=", &db::DeviceParameterDefinition::set_si_scaling,
gsi::method ("si_scaling=", &db::DeviceParameterDefinition::set_si_scaling, gsi::arg ("flag"),
"@brief Sets the scaling factor to SI units.\n"
"\n"
"This setter has been added in version 0.28.6."
@ -850,7 +850,7 @@ Class<db::DeviceParameterDefinition> decl_dbDeviceParameterDefinition ("db", "De
"\n"
"This attribute has been added in version 0.28.6."
) +
gsi::method ("geo_scaling_exponent=", &db::DeviceParameterDefinition::set_geo_scaling_exponent,
gsi::method ("geo_scaling_exponent=", &db::DeviceParameterDefinition::set_geo_scaling_exponent, gsi::arg ("expo"),
"@brief Sets the geometry scaling exponent.\n"
"See \\geo_scaling_exponent for details.\n"
"\n"
@ -1979,7 +1979,7 @@ Class<db::Netlist> decl_dbNetlist ("db", "Netlist",
"@brief Flattens all circuits of the netlist\n"
"After calling this method, only the top circuits will remain."
) +
gsi::method ("flatten_circuits", &db::Netlist::flatten_circuits,
gsi::method ("flatten_circuits", &db::Netlist::flatten_circuits, gsi::arg ("circuits"),
"@brief Flattens all given circuits of the netlist\n"
"This method is equivalent to calling \\flatten_circuit for all given circuits, but more efficient.\n"
"\n"
@ -2333,7 +2333,7 @@ Class<db::NetlistSpiceWriter> db_NetlistSpiceWriter (db_NetlistWriter, "db", "Ne
gsi::constructor ("new", &new_spice_writer,
"@brief Creates a new writer without delegate.\n"
) +
gsi::constructor ("new", &new_spice_writer2,
gsi::constructor ("new", &new_spice_writer2, gsi::arg ("delegate"),
"@brief Creates a new writer with a delegate.\n"
) +
gsi::method ("use_net_names=", &db::NetlistSpiceWriter::set_use_net_names, gsi::arg ("f"),

2
src/db/db/gsiDeclDbReader.cc
View File

@ -319,7 +319,7 @@ namespace gsi
gsi::method ("clear", &db::LayerMap::clear,
"@brief Clears the map\n"
) +
gsi::method ("from_string", &db::LayerMap::from_string_file_format,
gsi::method ("from_string", &db::LayerMap::from_string_file_format, gsi::arg ("s"),
"@brief Creates a layer map from the given string\n"
"The format of the string is that used in layer mapping files: one mapping entry "
"per line, comments are allowed using '#' or '//'. The format of each line is that "

2
src/db/db/gsiDeclDbRecursiveShapeIterator.cc
View File

@ -396,7 +396,7 @@ Class<db::RecursiveShapeIterator> decl_RecursiveShapeIterator ("db", "RecursiveS
"\n"
"This method has been introduced in version 0.27.\n"
) +
gsi::method_ext ("global_dtrans=", &si_set_global_dtrans,
gsi::method_ext ("global_dtrans=", &si_set_global_dtrans, gsi::arg ("t"),
"@brief Sets the global transformation to apply to all shapes delivered (transformation in micrometer units)\n"
"The global transformation will be applied to all shapes delivered by biasing the \"trans\" attribute.\n"
"The search regions apply to the coordinate space after global transformation.\n"

2
src/db/db/gsiDeclDbShape.cc
View File

@ -1151,7 +1151,7 @@ Class<db::Shape> decl_Shape ("db", "Shape",
"\n"
"The \\Layout object can be used to retrieve the actual properties associated with the ID."
) +
gsi::method_ext ("prop_id=", &set_prop_id,
gsi::method_ext ("prop_id=", &set_prop_id, gsi::arg ("id"),
"@brief Sets the properties ID of this shape\n"
"\n"
"The \\Layout object can be used to retrieve an ID for a given set of properties. "

12
src/gsi/gsi/gsiDeclInternal.cc
View File

@ -158,10 +158,10 @@ Class<ArgType> decl_ArgType ("tl", "ArgType",
"@brief Returns the name for this argument or an empty string if the argument is not named\n"
"Applies to arguments only. This method has been introduced in version 0.24."
) +
gsi::method ("==", &ArgType::operator==,
gsi::method ("==", &ArgType::operator==, gsi::arg ("other"),
"@brief Equality of two types\n"
) +
gsi::method ("!=", &ArgType::operator!=,
gsi::method ("!=", &ArgType::operator!=, gsi::arg ("other"),
"@brief Inequality of two types\n"
),
"@hide"
@ -230,7 +230,7 @@ Class<MethodBase> decl_Method ("tl", "Method",
"\n"
"This method has been introduced in version 0.24."
) +
gsi::method ("accepts_num_args", &MethodBase::compatible_with_num_args,
gsi::method ("accepts_num_args", &MethodBase::compatible_with_num_args, gsi::arg ("n"),
"@brief True, if this method is compatible with the given number of arguments\n"
"\n"
"This method has been introduced in version 0.24."
@ -276,6 +276,12 @@ Class<MethodBase> decl_Method ("tl", "Method",
"\n"
"This method has been introduced in version 0.24."
) +
gsi::method ("to_s", &MethodBase::to_string,
"@brief Describes the method\n"
"This attribute returns a string description of the method and its signature.\n"
"\n"
"This method has been introduced in version 0.29."
) +
gsi::method ("doc", &MethodBase::doc,
"@brief The documentation string for this method\n"
),

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

@ -98,8 +98,8 @@ template <class C>
static gsi::Methods application_methods ()
{
return
method<int> ("crash_me", &crash_me, "@hide") +
method<QString, const QString &, size_t> ("symname", &lay::get_symbol_name_from_address, "@hide") +
method<int> ("crash_me", &crash_me, gsi::arg ("mode"), "@hide") +
method<QString, const QString &, size_t> ("symname", &lay::get_symbol_name_from_address, gsi::arg ("mod_name"), gsi::arg ("addr"), "@hide") +
method<C, bool> ("is_editable?", &C::is_editable,
"@brief Returns true if the application is in editable mode\n"
) +

2
src/lay/lay/gsiDeclLayMainWindow.cc
View File

@ -433,7 +433,7 @@ Class<lay::MainWindow> decl_MainWindow (QT_EXTERNAL_BASE (QMainWindow) "lay", "M
"\n"
"This method has been introduced in version 0.27.\n"
) +
gsi::method_ext ("set_menu_items_hidden", &set_menu_items_hidden,
gsi::method_ext ("set_menu_items_hidden", &set_menu_items_hidden, gsi::arg ("flags"),
"@brief sets the flags indicating whether menu items are hidden\n"
"This method allows hiding certain menu items. It takes a hash with hidden flags vs. menu item paths. "
"\n"

4
src/laybasic/laybasic/gsiDeclLayLayers.cc
View File

@ -1028,7 +1028,7 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.22."
) +
method_ext ("lower_hier_level_mode", &get_lower_hier_level_mode,
method_ext ("lower_hier_level_mode", &get_lower_hier_level_mode, gsi::arg ("real"),
"@brief Gets the mode for the lower hierarchy level.\n"
"@param real If true, the computed value is returned, otherwise the local node value\n"
"\n"
@ -1036,7 +1036,7 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"\n"
"This method has been introduced in version 0.20.\n"
) +
method_ext ("lower_hier_level_mode", &get_lower_hier_level_mode_1,
method_ext ("lower_hier_level_mode", &get_lower_hier_level_mode_1,
"@brief Gets the mode for the lower hierarchy level.\n"
"\n"
"This method is a convenience method for \"lower_hier_level_mode(true)\"\n"

4
src/laybasic/laybasic/gsiDeclLayLayoutViewBase.cc
View File

@ -955,7 +955,7 @@ LAYBASIC_PUBLIC Class<lay::LayoutViewBase> decl_LayoutViewBase ("lay", "LayoutVi
"\n"
"@param props The layer properties object to initialize."
) +
gsi::method ("switch_mode", static_cast<void (lay::LayoutViewBase::*) (const std::string &)> (&lay::LayoutViewBase::switch_mode),
gsi::method ("switch_mode", static_cast<void (lay::LayoutViewBase::*) (const std::string &)> (&lay::LayoutViewBase::switch_mode), gsi::arg ("mode"),
"@brief Switches the mode.\n"
"\n"
"See \\mode_name about a method to get the name of the current mode and \\mode_names for a method "
@ -1136,7 +1136,7 @@ LAYBASIC_PUBLIC Class<lay::LayoutViewBase> decl_LayoutViewBase ("lay", "LayoutVi
"Show the layout in full depth down to the deepest level of hierarchy. "
"This method may cause a redraw."
) +
gsi::method ("resize", static_cast<void (lay::LayoutViewBase::*) (unsigned int, unsigned int)> (&lay::LayoutViewBase::resize),
gsi::method ("resize", static_cast<void (lay::LayoutViewBase::*) (unsigned int, unsigned int)> (&lay::LayoutViewBase::resize), gsi::arg ("w"), gsi::arg ("h"),
"@brief Resizes the layout view to the given dimension\n"
"\n"
"This method has been made available in all builds in 0.28.\n"

4
src/layui/layui/gsiDeclLayDialogs.cc
View File

@ -387,7 +387,7 @@ Class<lay::BrowserSource> decl_BrowserSource ("lay", "BrowserSource_Native",
#endif
gsi::method ("next_topic", &lay::BrowserSource::next_topic, gsi::arg ("url")) +
gsi::method ("prev_topic", &lay::BrowserSource::prev_topic, gsi::arg ("url")) +
gsi::method ("get", &lay::BrowserSource::get),
gsi::method ("get", &lay::BrowserSource::get, gsi::arg ("url")),
"@hide\n@alias BrowserSource"
);
@ -398,7 +398,7 @@ Class<lay::BrowserSource> &laybasicdecl_BrowserSource ()
}
Class<BrowserSource_Stub> decl_BrowserSourceStub ("lay", "BrowserSource",
gsi::constructor ("new|#new_html", &new_html,
gsi::constructor ("new|#new_html", &new_html, gsi::arg ("html"),
"@brief Constructs a BrowserSource object with a default HTML string\n"
"\n"
"The default HTML string is sent when no specific implementation is provided.\n"

8
src/plugins/streamers/cif/db_plugin/gsiDeclDbCIF.cc
View File

@ -167,7 +167,7 @@ gsi::ClassExt<db::LoadLayoutOptions> cif_reader_options (
"\n"
"This method has been added in version 0.25.3."
) +
gsi::method_ext ("cif_wire_mode=", &set_cif_wire_mode,
gsi::method_ext ("cif_wire_mode=", &set_cif_wire_mode, gsi::arg ("mode"),
"@brief How to read 'W' objects\n"
"\n"
"This property specifies how to read 'W' (wire) objects.\n"
@ -179,7 +179,7 @@ gsi::ClassExt<db::LoadLayoutOptions> cif_reader_options (
"See \\cif_wire_mode= method for a description of this mode."
"\nThis property has been added in version 0.21 and was renamed to cif_wire_mode in 0.25.\n"
) +
gsi::method_ext ("cif_dbu=", &set_cif_dbu,
gsi::method_ext ("cif_dbu=", &set_cif_dbu, gsi::arg ("dbu"),
"@brief Specifies the database unit which the reader uses and produces\n"
"\nThis property has been added in version 0.21.\n"
) +
@ -217,7 +217,7 @@ static bool get_cif_blank_separator (const db::SaveLayoutOptions *options)
// extend lay::SaveLayoutOptions with the CIF options
static
gsi::ClassExt<db::SaveLayoutOptions> cif_writer_options (
gsi::method_ext ("cif_dummy_calls=", &set_cif_dummy_calls,
gsi::method_ext ("cif_dummy_calls=", &set_cif_dummy_calls, gsi::arg ("flag"),
"@brief Sets a flag indicating whether dummy calls shall be written\n"
"If this property is set to true, dummy calls will be written in the top level entity "
"of the CIF file calling every top cell.\n"
@ -230,7 +230,7 @@ gsi::ClassExt<db::SaveLayoutOptions> cif_writer_options (
"\nThis property has been added in version 0.23.10.\n"
"\nThe predicate version (cif_blank_separator?) has been added in version 0.25.1.\n"
) +
gsi::method_ext ("cif_blank_separator=", &set_cif_blank_separator,
gsi::method_ext ("cif_blank_separator=", &set_cif_blank_separator, gsi::arg ("flag"),
"@brief Sets a flag indicating whether blanks shall be used as x/y separator characters\n"
"If this property is set to true, the x and y coordinates are separated with blank characters "
"rather than comma characters."

6
src/plugins/streamers/gds2/db_plugin/gsiDeclDbGDS2.cc
View File

@ -300,7 +300,7 @@ static bool get_gds2_allow_big_records (const db::LoadLayoutOptions *options)
// extend lay::LoadLayoutOptions with the GDS2 options
static
gsi::ClassExt<db::LoadLayoutOptions> gds2_reader_options (
gsi::method_ext ("gds2_box_mode=", &set_gds2_box_mode,
gsi::method_ext ("gds2_box_mode=", &set_gds2_box_mode, gsi::arg ("mode"),
"@brief Sets a value specifying how to treat BOX records\n"
"This property specifies how BOX records are treated.\n"
"Allowed values are 0 (ignore), 1 (treat as rectangles), 2 (treat as boundaries) or 3 (treat as errors). The default is 1.\n"
@ -311,7 +311,7 @@ gsi::ClassExt<db::LoadLayoutOptions> gds2_reader_options (
"See \\gds2_box_mode= method for a description of this mode."
"\nThis property has been added in version 0.18.\n"
) +
gsi::method_ext ("gds2_allow_multi_xy_records=", &set_gds2_allow_multi_xy_records,
gsi::method_ext ("gds2_allow_multi_xy_records=", &set_gds2_allow_multi_xy_records, gsi::arg ("flag"),
"@brief Allows the use of multiple XY records in BOUNDARY elements for unlimited large polygons\n"
"\n"
"Setting this property to true allows big polygons that span over multiple XY records.\n"
@ -323,7 +323,7 @@ gsi::ClassExt<db::LoadLayoutOptions> gds2_reader_options (
"See \\gds2_allow_multi_xy_records= method for a description of this property."
"\nThis property has been added in version 0.18.\n"
) +
gsi::method_ext ("gds2_allow_big_records=", &set_gds2_allow_big_records,
gsi::method_ext ("gds2_allow_big_records=", &set_gds2_allow_big_records, gsi::arg ("flag"),
"@brief Allows big records with more than 32767 bytes\n"
"\n"
"Setting this property to true allows larger records by treating the record length as unsigned short, which for example "

6
src/plugins/streamers/oasis/db_plugin/gsiDeclDbOASIS.cc
View File

@ -56,7 +56,7 @@ static int get_oasis_expect_strict_mode (const db::LoadLayoutOptions *options)
// extend lay::LoadLayoutOptions with the OASIS options
static
gsi::ClassExt<db::LoadLayoutOptions> oasis_reader_options (
gsi::method_ext ("oasis_read_all_properties=", &set_oasis_read_all_properties,
gsi::method_ext ("oasis_read_all_properties=", &set_oasis_read_all_properties, gsi::arg ("flag"),
// this method is mainly provided as access point for the generic interface
"@hide"
) +
@ -64,7 +64,7 @@ gsi::ClassExt<db::LoadLayoutOptions> oasis_reader_options (
// this method is mainly provided as access point for the generic interface
"@hide"
) +
gsi::method_ext ("oasis_expect_strict_mode=", &set_oasis_expect_strict_mode,
gsi::method_ext ("oasis_expect_strict_mode=", &set_oasis_expect_strict_mode, gsi::arg ("flag"),
// this method is mainly provided as access point for the generic interface
"@hide"
) +
@ -270,7 +270,7 @@ gsi::ClassExt<db::SaveLayoutOptions> oasis_writer_options (
"\n"
"This method has been introduced in version 0.24."
) +
gsi::method_ext ("oasis_write_std_properties_ext=", &set_oasis_write_std_properties_ext,
gsi::method_ext ("oasis_write_std_properties_ext=", &set_oasis_write_std_properties_ext, gsi::arg ("flag"),
// this method is mainly provided as access point for the generic interface
"@hide"
) +

2
src/rdb/rdb/gsiDeclRdb.cc
View File

@ -819,7 +819,7 @@ Class<rdb::Item> decl_RdbItem ("rdb", "RdbItem",
"\n"
"This method has been added in version 0.28."
) +
gsi::method ("image=", static_cast<void (rdb::Item::*) (const tl::PixelBuffer &)> (&rdb::Item::set_image),
gsi::method ("image=", static_cast<void (rdb::Item::*) (const tl::PixelBuffer &)> (&rdb::Item::set_image), gsi::arg ("buffer"),
"@brief Sets the attached image from a PixelBuffer object\n"
"\n"
"This method has been added in version 0.28."