From 25b978f39fd5303b0f8d79c0ce3afb69c6098c4d Mon Sep 17 00:00:00 2001 From: Matthias Koefferlein Date: Thu, 1 Apr 2021 18:41:37 +0200 Subject: [PATCH] Doc clarification. --- src/db/db/gsiDeclDbLayout.cc | 6 ++++-- src/laybasic/laybasic/gsiDeclLayLayers.cc | 6 +++--- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/src/db/db/gsiDeclDbLayout.cc b/src/db/db/gsiDeclDbLayout.cc index b950970b5..6ceeed6f6 100644 --- a/src/db/db/gsiDeclDbLayout.cc +++ b/src/db/db/gsiDeclDbLayout.cc @@ -1349,12 +1349,14 @@ Class 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. " "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 (), "[]"), "@brief Cleans up the layout\n" "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" "\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" ) + gsi::method ("dbu=", (void (db::Layout::*) (double)) &db::Layout::dbu, gsi::arg ("dbu"), diff --git a/src/laybasic/laybasic/gsiDeclLayLayers.cc b/src/laybasic/laybasic/gsiDeclLayLayers.cc index e04356784..75fd91eac 100644 --- a/src/laybasic/laybasic/gsiDeclLayLayers.cc +++ b/src/laybasic/laybasic/gsiDeclLayLayers.cc @@ -835,9 +835,9 @@ Class decl_LayerProperties ("lay", "LayerProperties", "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 " "name specification.\n\n" - "The similar method \\layer_index " - "returns the actual layer index used, not the given one. The latter may be negative indicating " - "that layer/datatype or name specifications are used.\n\n" + "A different method is \\layer_index which indicates the ID of the layer actually used. " + "While \"source_layer_index\" is one of several ways to address the layer drawn, \"layer_index\" is the ID (index) " + "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." ) + method_ext ("source_layer_index", &get_layer_index_1,