mirror of
https://github.com/KLayout/klayout.git
synced 2026-09-01 18:37:50 +02:00
Spelling errors in code and comments fixed
This commit is contained in:
@@ -360,7 +360,7 @@ Class<BrowserDialog_Stub> decl_BrowserDialog (QT_EXTERNAL_BASE (QDialog) "lay",
|
||||
"@brief Reloads the current page"
|
||||
) +
|
||||
gsi::method ("home=|#set_home", &BrowserDialog_Stub::set_home,
|
||||
"@brief Sets the browser's initial and current URL which is selected if the \"home\" location is choosen\n"
|
||||
"@brief Sets the browser's initial and current URL which is selected if the \"home\" location is chosen\n"
|
||||
"@args home_url\n"
|
||||
"The home URL is the one shown initially and the one which is selected when the \"home\" button is pressed. "
|
||||
"The default location is \"int:/index.html\".\n"
|
||||
@@ -513,7 +513,7 @@ Class<lay::BrowserPanel> decl_BrowserPanel (QT_EXTERNAL_BASE (QWidget) "lay", "B
|
||||
"@brief Reloads the current page"
|
||||
) +
|
||||
gsi::method ("home=", &lay::BrowserPanel::set_home,
|
||||
"@brief Sets the browser widget's initial and current URL which is selected if the \"home\" location is choosen\n"
|
||||
"@brief Sets the browser widget's initial and current URL which is selected if the \"home\" location is chosen\n"
|
||||
"@args home_url\n"
|
||||
"The home URL is the one shown initially and the one which is selected when the \"home\" button is pressed. "
|
||||
"The default location is \"int:/index.html\".\n"
|
||||
@@ -726,7 +726,7 @@ Class<InputDialog> decl_InputDialog ("lay", "InputDialog",
|
||||
"@param title The title to display for the dialog\n"
|
||||
"@param label The label text to display for the dialog\n"
|
||||
"@param items The list of items to show in the selection element\n"
|
||||
"@param selection The initial selection (index of the element selected intially)\n"
|
||||
"@param selection The initial selection (index of the element selected initially)\n"
|
||||
"@return A \\StringValue object with has_value? set to true, if \"Ok\" was pressed and the value given in it's value attribute\n"
|
||||
"Starting from 0.22, this method is deprecated and it is recommended to use the ask_... equivalent."
|
||||
) +
|
||||
|
||||
@@ -978,7 +978,7 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
|
||||
"This is the hierarchy level at which the drawing starts. "
|
||||
"This property is only meaningful, if \\has_upper_hier_level is true. "
|
||||
"The hierarchy level can be relative in which case, 0 refers to the context cell's level. "
|
||||
"A mode can be specfied for the hierarchy level which is 0 for absolute, 1 for minimum "
|
||||
"A mode can be specified for the hierarchy level which is 0 for absolute, 1 for minimum "
|
||||
"of specified level and set level and 2 for maximum of specified level and set level. "
|
||||
) +
|
||||
method_ext ("upper_hier_level", &get_upper_hier_level_1,
|
||||
@@ -1069,7 +1069,7 @@ Class<lay::LayerProperties> decl_LayerProperties ("lay", "LayerProperties",
|
||||
"This is the hierarchy level at which the drawing starts. "
|
||||
"This property is only meaningful, if \\has_lower_hier_level is true. "
|
||||
"The hierarchy level can be relative in which case, 0 refers to the context cell's level. "
|
||||
"A mode can be specfied for the hierarchy level which is 0 for absolute, 1 for minimum "
|
||||
"A mode can be specified for the hierarchy level which is 0 for absolute, 1 for minimum "
|
||||
"of specified level and set level and 2 for maximum of specified level and set level. "
|
||||
) +
|
||||
method_ext ("lower_hier_level", &get_lower_hier_level_1,
|
||||
|
||||
@@ -676,7 +676,7 @@ Class<lay::LayoutView> decl_LayoutView (QT_EXTERNAL_BASE (QWidget) "lay", "Layou
|
||||
"current path is returned for the cellview given by cv_index.\n"
|
||||
"The cell path is a list of cell indices from the top cell to the current cell.\n"
|
||||
"\n"
|
||||
"@param cv_index The cellview index for which to get the current path from (usally this will be the active cellview index)"
|
||||
"@param cv_index The cellview index for which to get the current path from (usually this will be the active cellview index)"
|
||||
"\n"
|
||||
"This method is was deprecated in version 0.25 since from then, the \\CellView object can be used to obtain an manipulate the selected cell."
|
||||
) +
|
||||
@@ -684,10 +684,10 @@ Class<lay::LayoutView> decl_LayoutView (QT_EXTERNAL_BASE (QWidget) "lay", "Layou
|
||||
"@brief Sets the path to the current cell\n"
|
||||
"\n"
|
||||
"The current cell is the one highlighted in the browser with the focus rectangle. The\n"
|
||||
"cell given by the path is hightlighted and scrolled into view.\n"
|
||||
"cell given by the path is highlighted and scrolled into view.\n"
|
||||
"To select the cell to be drawn, use the \\select_cell or \\select_cell_path method.\n"
|
||||
"\n"
|
||||
"@param cv_index The cellview index for which to set the current path for (usally this will be the active cellview index)\n"
|
||||
"@param cv_index The cellview index for which to set the current path for (usually this will be the active cellview index)\n"
|
||||
"@param path The path to the current cell\n"
|
||||
"\n"
|
||||
"This method is was deprecated in version 0.25 since from then, the \\CellView object can be used to obtain an manipulate the selected cell."
|
||||
@@ -1020,7 +1020,7 @@ Class<lay::LayoutView> decl_LayoutView (QT_EXTERNAL_BASE (QWidget) "lay", "Layou
|
||||
"\n"
|
||||
"This method inserts the new properties node before the position given by \"iter\" and returns "
|
||||
"a const reference to the element created. The iterator that specified the position will remain valid "
|
||||
"after the node was inserted and will point to the newly created node. It can be used to add futher nodes. "
|
||||
"after the node was inserted and will point to the newly created node. It can be used to add further nodes. "
|
||||
"To add children to the node inserted, use iter.last_child as insertion point for the next insert operations.\n"
|
||||
"\n"
|
||||
"Since version 0.22, this method accepts LayerProperties and LayerPropertiesNode objects. A LayerPropertiesNode "
|
||||
@@ -1034,7 +1034,7 @@ Class<lay::LayoutView> decl_LayoutView (QT_EXTERNAL_BASE (QWidget) "lay", "Layou
|
||||
"This version addresses a specific list in a multi-tab layer properties arrangement with the \"index\" parameter. "
|
||||
"This method inserts the new properties node before the position given by \"iter\" and returns "
|
||||
"a const reference to the element created. The iterator that specified the position will remain valid "
|
||||
"after the node was inserted and will point to the newly created node. It can be used to add futher nodes. "
|
||||
"after the node was inserted and will point to the newly created node. It can be used to add further nodes. "
|
||||
"\n"
|
||||
"This method has been introduced in version 0.21.\n"
|
||||
"Since version 0.22, this method accepts LayerProperties and LayerPropertiesNode objects. A LayerPropertiesNode "
|
||||
@@ -1104,7 +1104,7 @@ Class<lay::LayoutView> decl_LayoutView (QT_EXTERNAL_BASE (QWidget) "lay", "Layou
|
||||
"This iterator delivers the layers of this view, either in a recursive or non-recursive\n"
|
||||
"fashion, depending which iterator increment methods are used.\n"
|
||||
"The iterator delivered by \\end_layers is the past-the-end iterator. It can be compared\n"
|
||||
"agains a current iterator to check, if there are no further elements.\n"
|
||||
"against a current iterator to check, if there are no further elements.\n"
|
||||
"\n"
|
||||
"Starting from version 0.25, an alternative solution is provided with 'each_layer' which is based on the "
|
||||
"\\LayerPropertiesNodeRef class."
|
||||
@@ -1119,7 +1119,7 @@ Class<lay::LayoutView> decl_LayoutView (QT_EXTERNAL_BASE (QWidget) "lay", "Layou
|
||||
"This iterator delivers the layers of this view, either in a recursive or non-recursive\n"
|
||||
"fashion, depending which iterator increment methods are used.\n"
|
||||
"The iterator delivered by \\end_layers is the past-the-end iterator. It can be compared\n"
|
||||
"agains a current iterator to check, if there are no further elements.\n"
|
||||
"against a current iterator to check, if there are no further elements.\n"
|
||||
"This version addresses a specific list in a multi-tab layer properties arrangement with the \"index\" parameter. "
|
||||
"This method has been introduced in version 0.21.\n"
|
||||
) +
|
||||
@@ -1497,7 +1497,7 @@ Class<lay::LayoutView> decl_LayoutView (QT_EXTERNAL_BASE (QWidget) "lay", "Layou
|
||||
"A transaction brackets a sequence of database modifications that appear as a single "
|
||||
"undo action. Only modifications that are wrapped inside a transaction..commit call pair "
|
||||
"can be undone.\n"
|
||||
"Each transaction must be terminated with a \\commit method call, even if some error occured. "
|
||||
"Each transaction must be terminated with a \\commit method call, even if some error occurred. "
|
||||
"It is advisable therefore to catch errors and issue a commit call in this case.\n"
|
||||
"\n"
|
||||
"This method was introduced in version 0.16."
|
||||
|
||||
@@ -123,7 +123,7 @@ Class<lay::AbstractMenu> decl_AbstractMenu ("lay", "AbstractMenu",
|
||||
"\n"
|
||||
"@<table>\n"
|
||||
" @<tr>@<td>\"\" @</td>@<td>is the root@</td>@</tr> \n"
|
||||
" @<tr>@<td>\"[<path>.]<name>\" @</td>@<td>is an element of the submenu given by <path>. If <path> is ommitted, this refers to an element in the root@</td>@</tr> \n"
|
||||
" @<tr>@<td>\"[<path>.]<name>\" @</td>@<td>is an element of the submenu given by <path>. If <path> is omitted, this refers to an element in the root@</td>@</tr> \n"
|
||||
" @<tr>@<td>\"[<path>.]end\" @</td>@<td>refers to the item past the last item of the submenu given by <path> or root@</td>@</tr>\n"
|
||||
" @<tr>@<td>\"[<path>.]begin\" @</td>@<td>refers to the first item of the submenu given by <path> or root@</td>@</tr>\n"
|
||||
" @<tr>@<td>\"[<path>.]#<n>\" @</td>@<td>refers to the nth item of the submenu given by <path> or root (n is an integer number)@</td>@</tr>\n"
|
||||
|
||||
@@ -905,7 +905,7 @@ Class<lay::PluginRoot> decl_PluginRoot ("lay", "PluginRoot",
|
||||
"@return A value indicating whether the operation was successful\n"
|
||||
"\n"
|
||||
"This method siletly does nothing, if the config file does not\n"
|
||||
"exist. If it does and an error occured, the error message is printed\n"
|
||||
"exist. If it does and an error occurred, the error message is printed\n"
|
||||
"on stderr. In both cases, false is returned.\n"
|
||||
) +
|
||||
method_ext ("get_config", &get_config,
|
||||
|
||||
@@ -624,7 +624,7 @@ private:
|
||||
* Menu items and submenus are referred to by a "path". The path is a string with this interpretation:
|
||||
*
|
||||
* "" is the root
|
||||
* "[<path>.]<name>" is an element of the submenu given by <path>. If <path> is ommitted, this refers to
|
||||
* "[<path>.]<name>" is an element of the submenu given by <path>. If <path> is omitted, this refers to
|
||||
* an element in the root
|
||||
* "[<path>.]end refers to the item past the last item of the submenu given by <path> or root
|
||||
* "[<path>.]begin refers to the first item of the submenu given by <path> or root
|
||||
|
||||
@@ -37,7 +37,7 @@ namespace lay
|
||||
* The renderer is supposed to render a set of edges to
|
||||
* one or more bitmaps. One bitmap holds the contour
|
||||
* information, one the fill. A third one holds the
|
||||
* vertex informations (dots).
|
||||
* vertex information (dots).
|
||||
*
|
||||
* The intended use model is first to reserve a number of
|
||||
* points if necessary, the fill the renderer with the
|
||||
|
||||
@@ -534,7 +534,7 @@ bitmaps_to_image_rgb (const std::vector<lay::ViewOp> &view_ops_in,
|
||||
|
||||
}
|
||||
|
||||
// Collect all necessary informations to transfer a single scanline ..
|
||||
// Collect all necessary information to transfer a single scanline ..
|
||||
|
||||
masks.erase (masks.begin (), masks.end ());
|
||||
|
||||
|
||||
@@ -140,7 +140,7 @@ public:
|
||||
* The pattern returned is guaranteed to be at least of
|
||||
* size (32*pattern_stride)x64 bits. If the actual width or height is smaller,
|
||||
* the pattern is repeated to fill this area.
|
||||
* The pattern stride may be bigger than 1 to accomodate pattern with
|
||||
* The pattern stride may be bigger than 1 to accommodate pattern with
|
||||
* a width that is not a fraction of 32. Such pattern are repeated until
|
||||
* they fill a multiple of 32 bits.
|
||||
*/
|
||||
|
||||
@@ -136,7 +136,7 @@ public:
|
||||
* proximity is a typical distance value of the point to the closest
|
||||
* object in micron. The plugin with the least point selection proximity
|
||||
* is selected first for the actual "select" operation.
|
||||
* If a plugin definitly wants to get the selection, it should return
|
||||
* If a plugin definitely wants to get the selection, it should return
|
||||
* a negative value. If the plugin is only weakly interested in a selection,
|
||||
* it should return the value provided by the default implementation.
|
||||
* The click_proximity method can be used to implement cycling through
|
||||
@@ -186,7 +186,7 @@ public:
|
||||
* This method is used by the single-point selection cycling protocol to clear the
|
||||
* plugin's single-point selection state. The cycling protocol is used when a certain
|
||||
* point is clicked at multiple times. A plugin is supposed to remember such selections and
|
||||
* exlcude them from futher checks. If all objects in question are selected, no further
|
||||
* exlcude them from further checks. If all objects in question are selected, no further
|
||||
* object would be selected. clear_previous_selection is called in that case to indicate that
|
||||
* the previous selection should be cleared and a new cycle is about to begin
|
||||
*/
|
||||
|
||||
@@ -1438,7 +1438,7 @@ LayerPropertiesList::expand (const std::map<int, int> &map_cv_index, bool add_de
|
||||
|
||||
}
|
||||
|
||||
// erase the items specfied to removal (cv mapping to -1)
|
||||
// erase the items specified to removal (cv mapping to -1)
|
||||
for (std::set<int>::const_iterator cv = cvrefs_to_erase.begin (); cv != cvrefs_to_erase.end (); ++cv) {
|
||||
remove_cv_references (*cv, false);
|
||||
}
|
||||
|
||||
@@ -2613,7 +2613,7 @@ LayoutView::add_new_layers (const std::vector <unsigned int> &layer_ids, int cv_
|
||||
lay::LayerPropertiesList new_props (get_properties ());
|
||||
|
||||
// don't create new layers for those, for which there are layers already: compute a
|
||||
// set of layers alreay present
|
||||
// set of layers already present
|
||||
std::set <db::LayerProperties, db::LPLogicalLessFunc> present_layers;
|
||||
for (LayerPropertiesConstIterator lay_iter = begin_layers (); ! lay_iter.at_end (); ++lay_iter) {
|
||||
if (! lay_iter->has_children () && lay_iter->cellview_index () == cv_index) {
|
||||
@@ -4279,7 +4279,7 @@ LayoutView::max_hier_changed (int i)
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief set the maximum hierachy level to the number of levels available
|
||||
* @brief set the maximum hierarchy level to the number of levels available
|
||||
*/
|
||||
void
|
||||
LayoutView::max_hier ()
|
||||
|
||||
@@ -1451,7 +1451,7 @@ public:
|
||||
* @brief Set the path to the current cell
|
||||
*
|
||||
* The current cell is the one highlighted in the browser with the focus rectangle. The
|
||||
* cell given by the path is hightlighted and scrolled into view.
|
||||
* cell given by the path is highlighted and scrolled into view.
|
||||
*/
|
||||
void set_current_cell_path (int cv_index, const cell_path_type &path);
|
||||
|
||||
|
||||
@@ -132,7 +132,7 @@ public:
|
||||
* The pattern returned is guaranteed to be at least of
|
||||
* size (32*pattern_stride)x64 bits. If the actual width or height is smaller,
|
||||
* the pattern is repeated to fill this area.
|
||||
* The pattern stride may be bigger than 1 to accomodate pattern with
|
||||
* The pattern stride may be bigger than 1 to accommodate pattern with
|
||||
* a width that is not a fraction of 32. Such pattern are repeated until
|
||||
* they fill a multiple of 32 bits.
|
||||
*/
|
||||
|
||||
@@ -818,7 +818,7 @@ public:
|
||||
* If the configuration file cannot be written, false
|
||||
* is returned but no exception is thrown.
|
||||
*
|
||||
* @return false, if an error occured.
|
||||
* @return false, if an error occurred.
|
||||
*/
|
||||
bool write_config (const std::string &config_file);
|
||||
|
||||
@@ -826,10 +826,10 @@ public:
|
||||
* @brief Read the configuration from a file
|
||||
*
|
||||
* This method siletly does nothing, if the config file does not
|
||||
* exist. If it does and an error occured, the error message is printed
|
||||
* exist. If it does and an error occurred, the error message is printed
|
||||
* on stderr. In both cases, false is returned.
|
||||
*
|
||||
* @return false, if an error occured.
|
||||
* @return false, if an error occurred.
|
||||
*/
|
||||
bool read_config (const std::string &config_file);
|
||||
|
||||
|
||||
@@ -51,7 +51,7 @@ class CanvasPlane;
|
||||
* The renderer is supposed to render a set of edges to
|
||||
* one or more bitmaps. One bitmap holds the contour
|
||||
* information, one the fill. A third one holds the
|
||||
* vertex informations (dots).
|
||||
* vertex information (dots).
|
||||
*
|
||||
* The intended use model is first to reserve a number of
|
||||
* points if necessary, the fill the renderer with the
|
||||
|
||||
Reference in New Issue
Block a user