luke/klayout
1
0
Fork 0
mirror of https://github.com/KLayout/klayout.git synced 2026-08-22 14:07:15 +02:00
Code Issues Packages Projects Releases Wiki Activity

Doc clarification.

Browse Source
This commit is contained in:
Matthias Koefferlein
2021-04-01 18:41:37 +02:00
parent a9b414a2f5
commit 25b978f39f
2 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/db/db/gsiDeclDbLayout.cc
+4 -2
View File
@@ -1349,12 +1349,14 @@ Class<db::Layout> decl_Layout ("db", "Layout",
"This method is provided to ensure this explicitly. This can be useful while using \\start_changes and \\end_changes to wrap a performance-critical operation. " "This method is provided to ensure this explicitly. This can be useful while using \\start_changes and \\end_changes to wrap a performance-critical operation. "
"See \\start_changes for more details." "See \\start_changes for more details."
) + ) +
gsi::method ("cleanup", &db::Layout::cleanup, gsi::method ("cleanup", &db::Layout::cleanup, gsi::arg ("cell_indexes_to_keep", std::set<db::cell_index_type> (), "[]"),
"@brief Cleans up the layout\n" "@brief Cleans up the layout\n"
"This method will remove proxy objects that are no longer in use. After changing PCell parameters such " "This method will remove proxy objects that are no longer in use. After changing PCell parameters such "
"proxy objects may still be present in the layout and are cached for later reuse. Usually they are cleaned up automatically occasionally, " "proxy objects may still be present in the layout and are cached for later reuse. Usually they are cleaned up automatically, "
"but in a scripting context it may be useful to clean up these cells explicitly.\n" "but in a scripting context it may be useful to clean up these cells explicitly.\n"
"\n" "\n"
"Use 'cell_indexes_to_keep' for specifying a list of cell indexes of PCell variants or library proxies you don't want to be cleaned up.\n"
"\n"
"This method has been introduced in version 0.25.\n" "This method has been introduced in version 0.25.\n"
) + ) +
gsi::method ("dbu=", (void (db::Layout::*) (double)) &db::Layout::dbu, gsi::arg ("dbu"), gsi::method ("dbu=", (void (db::Layout::*) (double)) &db::Layout::dbu, gsi::arg ("dbu"),
src/laybasic/laybasic/gsiDeclLayLayers.cc
+3 -3
View File
@@ -835,9 +835,9 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
"If the layer index is positive, the shapes drawn are taken from this layer rather than " "If the layer index is positive, the shapes drawn are taken from this layer rather than "
"searched for by layer and datatype. This property is stronger than the layer/datatype or " "searched for by layer and datatype. This property is stronger than the layer/datatype or "
"name specification.\n\n" "name specification.\n\n"
"The similar method \\layer_index " "A different method is \\layer_index which indicates the ID of the layer actually used. "
"returns the actual layer index used, not the given one. The latter may be negative indicating " "While \"source_layer_index\" is one of several ways to address the layer drawn, \"layer_index\" is the ID (index) "
"that layer/datatype or name specifications are used.\n\n" "of the layer matching the source specification and is >= 0 if such a layer is found.\n\n"
"If \"real\" is true, the effective value is returned." "If \"real\" is true, the effective value is returned."
) + ) +
method_ext ("source_layer_index", &get_layer_index_1, method_ext ("source_layer_index", &get_layer_index_1,