mirror of https://github.com/KLayout/klayout.git
Fix typos systemically in gsiDecl*.cc
This commit is contained in:
parent
99ef222f50
commit
ff90c476c3
|
|
@ -776,7 +776,7 @@ Class<db::CompoundRegionOperationNode> decl_CompoundRegionOperationNode ("db", "
|
|||
"only act on subject shapes primarily. As a consequence, 'lonely' intruder shapes without a subject shape are "
|
||||
"not considered at all. Only subject shapes trigger evaluation of the operation tree.\n"
|
||||
"\n"
|
||||
"The search distance for introduder shapes is determined by the operation and computed from the operation's requirements.\n"
|
||||
"The search distance for intruder shapes is determined by the operation and computed from the operation's requirements.\n"
|
||||
"\n"
|
||||
"NOTE: this feature is experimental and not deployed into the the DRC framework yet.\n"
|
||||
"\n"
|
||||
|
|
|
|||
|
|
@ -537,7 +537,7 @@ struct edge_defs
|
|||
"@param box The clip box.\n"
|
||||
"@return The part of the line through the box or nil if the line does not intersect with the box.\n"
|
||||
"\n"
|
||||
"In contrast to \\clipped, this method will consider the edge exended infinitely (a \"line\"). "
|
||||
"In contrast to \\clipped, this method will consider the edge extended infinitely (a \"line\"). "
|
||||
"The returned edge will be the part of this line going through the box.\n"
|
||||
"\n"
|
||||
"This method has been introduced in version 0.26.2.\n"
|
||||
|
|
|
|||
|
|
@ -631,7 +631,7 @@ Class<db::Edges> decl_Edges (decl_dbShapeCollection, "db", "Edges",
|
|||
method_ext ("insert", &insert_s, gsi::arg ("shapes"),
|
||||
"@brief Inserts all edges from the shape collection into this edge collection\n"
|
||||
"This method takes each edge from the shape collection and "
|
||||
"insertes it into the region. \"Polygon-like\" objects are inserted as edges forming the contours of the polygons.\n"
|
||||
"inserts it into the region. \"Polygon-like\" objects are inserted as edges forming the contours of the polygons.\n"
|
||||
"Text objects are ignored.\n"
|
||||
"\n"
|
||||
"This method has been introduced in version 0.25."
|
||||
|
|
@ -1313,7 +1313,7 @@ Class<db::Edges> decl_Edges (decl_dbShapeCollection, "db", "Edges",
|
|||
"@param b the parallel extension at the start point of the edge\n"
|
||||
"@param e the parallel extension at the end point of the edge\n"
|
||||
"@param o the perpendicular extension to the \"outside\" (left side as seen in the direction of the edge)\n"
|
||||
"@param i the perpendicular extension to the \"inside\" (right side as seen in the dleftirection of the edge)\n"
|
||||
"@param i the perpendicular extension to the \"inside\" (right side as seen in the direction of the edge)\n"
|
||||
"@param join If true, connected edges are joined before the extension is applied\n"
|
||||
"@return A region containing the polygons representing these extended edges\n"
|
||||
"This is a generic version of \\extended_in and \\extended_out. It allows one to specify extensions for all four "
|
||||
|
|
|
|||
|
|
@ -106,7 +106,7 @@ Class<db::TextGenerator> decl_TextGenerator ("db", "TextGenerator",
|
|||
) +
|
||||
method ("glyph", &db::TextGenerator::glyph_as_region, arg ("char"),
|
||||
"@brief Gets the glyph of the given character as a region\n"
|
||||
"The region represents the glyph's outline and is deliverd in the generator's database units ."
|
||||
"The region represents the glyph's outline and is delivered in the generator's database units ."
|
||||
"A more elaborate way to getting the text's outline is \\text."
|
||||
) +
|
||||
method_ext ("dline_width", &dline_width,
|
||||
|
|
|
|||
|
|
@ -440,22 +440,22 @@ gsi::Class<LayoutDiff> decl_LayoutDiff ("db", "LayoutDiff",
|
|||
"full compare.\n"
|
||||
"\n"
|
||||
"This constant can be used for the flags parameter of \\compare_layouts and \\compare_cells. It can be "
|
||||
"compared with other contants to form a flag set."
|
||||
"compared with other constants to form a flag set."
|
||||
) +
|
||||
gsi::constant ("NoTextOrientation", &f_no_text_orientation,
|
||||
"@brief Ignore text orientation\n"
|
||||
"This constant can be used for the flags parameter of \\compare_layouts and \\compare_cells. It can be "
|
||||
"compared with other contants to form a flag set."
|
||||
"compared with other constants to form a flag set."
|
||||
) +
|
||||
gsi::constant ("NoProperties", &f_no_properties,
|
||||
"@brief Ignore properties\n"
|
||||
"This constant can be used for the flags parameter of \\compare_layouts and \\compare_cells. It can be "
|
||||
"compared with other contants to form a flag set."
|
||||
"compared with other constants to form a flag set."
|
||||
) +
|
||||
gsi::constant ("NoLayerNames", &f_no_layer_names,
|
||||
"@brief Do not compare layer names\n"
|
||||
"This constant can be used for the flags parameter of \\compare_layouts and \\compare_cells. It can be "
|
||||
"compared with other contants to form a flag set."
|
||||
"compared with other constants to form a flag set."
|
||||
) +
|
||||
gsi::constant ("Verbose", &f_verbose,
|
||||
"@brief Enables verbose mode (gives details about the differences)\n"
|
||||
|
|
@ -463,22 +463,22 @@ gsi::Class<LayoutDiff> decl_LayoutDiff ("db", "LayoutDiff",
|
|||
"See the event descriptions for details about the differences in verbose and non-verbose mode.\n"
|
||||
"\n"
|
||||
"This constant can be used for the flags parameter of \\compare_layouts and \\compare_cells. It can be "
|
||||
"compared with other contants to form a flag set."
|
||||
"compared with other constants to form a flag set."
|
||||
) +
|
||||
gsi::constant ("BoxesAsPolygons", &f_boxes_as_polygons,
|
||||
"@brief Compare boxes to polygons\n"
|
||||
"This constant can be used for the flags parameter of \\compare_layouts and \\compare_cells. It can be "
|
||||
"compared with other contants to form a flag set."
|
||||
"compared with other constants to form a flag set."
|
||||
) +
|
||||
gsi::constant ("FlattenArrayInsts", &f_flatten_array_insts,
|
||||
"@brief Compare array instances instance by instance\n"
|
||||
"This constant can be used for the flags parameter of \\compare_layouts and \\compare_cells. It can be "
|
||||
"compared with other contants to form a flag set."
|
||||
"compared with other constants to form a flag set."
|
||||
) +
|
||||
gsi::constant ("PathsAsPolygons", &f_paths_as_polygons,
|
||||
"@brief Compare paths to polygons\n"
|
||||
"This constant can be used for the flags parameter of \\compare_layouts and \\compare_cells. It can be "
|
||||
"compared with other contants to form a flag set."
|
||||
"compared with other constants to form a flag set."
|
||||
) +
|
||||
gsi::constant ("SmartCellMapping", &f_smart_cell_mapping,
|
||||
"@brief Derive smart cell mapping instead of name mapping (available only if top cells are specified)\n"
|
||||
|
|
@ -486,7 +486,7 @@ gsi::Class<LayoutDiff> decl_LayoutDiff ("db", "LayoutDiff",
|
|||
"cells are compared (with \\LayoutDiff#compare with cells instead of layout objects).\n"
|
||||
"\n"
|
||||
"This constant can be used for the flags parameter of \\compare_layouts and \\compare_cells. It can be "
|
||||
"compared with other contants to form a flag set.\n"
|
||||
"compared with other constants to form a flag set.\n"
|
||||
) +
|
||||
gsi::constant ("DontSummarizeMissingLayers", &f_dont_summarize_missing_layers,
|
||||
"@brief Don't summarize missing layers\n"
|
||||
|
|
@ -494,12 +494,12 @@ gsi::Class<LayoutDiff> decl_LayoutDiff ("db", "LayoutDiff",
|
|||
"layer will be reported as difference.\n"
|
||||
"\n"
|
||||
"This constant can be used for the flags parameter of \\compare_layouts and \\compare_cells. It can be "
|
||||
"compared with other contants to form a flag set."
|
||||
"compared with other constants to form a flag set."
|
||||
) +
|
||||
gsi::constant ("NoTextDetails", &f_no_text_details,
|
||||
"@brief Ignore text details (font, size, presentation)\n"
|
||||
"This constant can be used for the flags parameter of \\compare_layouts and \\compare_cells. It can be "
|
||||
"compared with other contants to form a flag set."
|
||||
"compared with other constants to form a flag set."
|
||||
) +
|
||||
gsi::method ("compare", &LayoutDiff::compare_layouts,
|
||||
gsi::arg("a"),
|
||||
|
|
|
|||
|
|
@ -162,7 +162,7 @@ LibraryClass decl_Library ("db", "Library",
|
|||
"\n"
|
||||
"This method will set the libraries' name.\n"
|
||||
"\n"
|
||||
"The technology specific bahvior has been introduced in version 0.27."
|
||||
"The technology specific behaviour has been introduced in version 0.27."
|
||||
) +
|
||||
gsi::method_ext ("delete", &delete_lib,
|
||||
"@brief Deletes the library\n"
|
||||
|
|
|
|||
|
|
@ -627,7 +627,7 @@ Class<db::Net> decl_dbNet (decl_dbNetlistObject, "db", "Net",
|
|||
) +
|
||||
gsi::method ("name=", &db::Net::set_name, gsi::arg ("name"),
|
||||
"@brief Sets the name of the net.\n"
|
||||
"The name of the net is used for nameing the net in schematic files for example. "
|
||||
"The name of the net is used for naming the net in schematic files for example. "
|
||||
"The name of the net has to be unique."
|
||||
) +
|
||||
gsi::method ("name", &db::Net::name,
|
||||
|
|
@ -1176,7 +1176,7 @@ Class<GenericDeviceClass> decl_GenericDeviceClass (decl_dbDeviceClass, "db", "Ge
|
|||
"Note that terminal equivalence is not effective if the device class operates in strict mode (see \\DeviceClass#strict=)."
|
||||
),
|
||||
"@brief A generic device class\n"
|
||||
"This class allows building generic device classes. Specificially, terminals can be defined "
|
||||
"This class allows building generic device classes. Specifically, terminals can be defined "
|
||||
"by adding terminal definitions. Terminal definitions should not be added dynamically. To create "
|
||||
"your own device, instantiate the \\GenericDeviceClass object, set name and description and "
|
||||
"specify the terminals. Then add this new device class to the \\Netlist object where it will live "
|
||||
|
|
@ -1857,7 +1857,7 @@ Class<db::Netlist> decl_dbNetlist ("db", "Netlist",
|
|||
"This method will eliminate all nets that make less than two connections."
|
||||
) +
|
||||
gsi::method ("simplify", &db::Netlist::simplify,
|
||||
"@brief Convience method that combines the simplification.\n"
|
||||
"@brief Convenience method that combines the simplification.\n"
|
||||
"This method is a convenience method that runs \\make_top_level_pins, \\purge, \\combine_devices and \\purge_nets."
|
||||
) +
|
||||
gsi::method_ext ("read", &read_netlist, gsi::arg ("file"), gsi::arg ("reader"),
|
||||
|
|
@ -1908,7 +1908,7 @@ public:
|
|||
reimpl_write_device_intro (const_cast<db::DeviceClass &> (ccls));
|
||||
}
|
||||
|
||||
// NOTE: we pass non-const refs to Ruby/Python - everthing else is a bit of a nightmare.
|
||||
// NOTE: we pass non-const refs to Ruby/Python - everything else is a bit of a nightmare.
|
||||
// Still that's not really clean. Just say, the implementation promises not to change the objects.
|
||||
void reimpl_write_device_intro (db::DeviceClass &cls) const
|
||||
{
|
||||
|
|
@ -2509,7 +2509,7 @@ Class<NetlistSpiceReaderDelegateImpl> db_NetlistSpiceReaderDelegate ("db", "Netl
|
|||
"@param element The upper-case element code (\"M\", \"R\", ...).\n"
|
||||
"@param name The element's name.\n"
|
||||
"@param model The upper-case model name (may be empty).\n"
|
||||
"@param value The default value (e.g. registance for resistors) and may be zero.\n"
|
||||
"@param value The default value (e.g. resistance for resistors) and may be zero.\n"
|
||||
"@param nets The nets given in the element line.\n"
|
||||
"@param parameters The parameters of the element statement (parameter names are upper case).\n"
|
||||
"\n"
|
||||
|
|
|
|||
|
|
@ -516,7 +516,7 @@ Class<db::NetlistComparer> decl_dbNetlistComparer ("db", "NetlistComparer",
|
|||
"To reset this constraint, set this attribute to zero."
|
||||
) +
|
||||
gsi::method ("max_depth=", &db::NetlistComparer::set_max_depth, gsi::arg ("n"),
|
||||
"@brief Sets the maximum seach depth\n"
|
||||
"@brief Sets the maximum search depth\n"
|
||||
"This value limits the search depth of the backtracking algorithm to the\n"
|
||||
"given number of jumps.\n"
|
||||
"\n"
|
||||
|
|
@ -524,7 +524,7 @@ Class<db::NetlistComparer> decl_dbNetlistComparer ("db", "NetlistComparer",
|
|||
"less elaborate matching evaluation.\n"
|
||||
) +
|
||||
gsi::method ("max_depth", &db::NetlistComparer::max_depth,
|
||||
"@brief Gets the maximum seach depth\n"
|
||||
"@brief Gets the maximum search depth\n"
|
||||
"See \\max_depth= for details."
|
||||
) +
|
||||
gsi::method ("max_branch_complexity=", &db::NetlistComparer::set_max_branch_complexity, gsi::arg ("n"),
|
||||
|
|
|
|||
|
|
@ -147,7 +147,7 @@ Class<db::DeviceClassDiode> decl_dbDeviceClassDiode (decl_dbDeviceClass, "db", "
|
|||
"@brief A constant giving the parameter ID for parameter P"
|
||||
),
|
||||
"@brief A device class for a diode.\n"
|
||||
"This class descibes a diode.\n"
|
||||
"This class describes a diode.\n"
|
||||
"A diode has two terminals, A (anode) and C (cathode).\n"
|
||||
"It has two parameters: The diode area in square micrometers (A) and the diode area perimeter in micrometers (P).\n"
|
||||
"\n"
|
||||
|
|
|
|||
|
|
@ -158,7 +158,7 @@ Class<db::NetlistDeviceExtractorError> decl_dbNetlistDeviceExtractorError ("db",
|
|||
"The device extractor will keep errors that occurred during extraction of the devices. "
|
||||
"It does not by using this error class.\n"
|
||||
"\n"
|
||||
"An error is basically described by the cell/circuit it occures in and the message. "
|
||||
"An error is basically described by the cell/circuit it occurs in and the message. "
|
||||
"In addition, a geometry may be attached forming a marker that can be shown when the error is selected. "
|
||||
"The geometry is given as a \\DPolygon object. If no geometry is specified, this polygon is empty.\n"
|
||||
"\n"
|
||||
|
|
@ -346,7 +346,7 @@ Class<GenericDeviceExtractor> decl_GenericDeviceExtractor (decl_dbNetlistDeviceE
|
|||
) +
|
||||
gsi::method ("error", (void (GenericDeviceExtractor::*) (const std::string &, const db::Polygon &)) &GenericDeviceExtractor::error,
|
||||
gsi::arg ("message"), gsi::arg ("geometry"),
|
||||
"@brief Issues an error with the given message and databse-unit polygon geometry\n"
|
||||
"@brief Issues an error with the given message and database-unit polygon geometry\n"
|
||||
) +
|
||||
gsi::method ("error", (void (GenericDeviceExtractor::*) (const std::string &, const std::string &, const std::string &)) &GenericDeviceExtractor::error,
|
||||
gsi::arg ("category_name"), gsi::arg ("category_description"), gsi::arg ("message"),
|
||||
|
|
@ -358,7 +358,7 @@ Class<GenericDeviceExtractor> decl_GenericDeviceExtractor (decl_dbNetlistDeviceE
|
|||
) +
|
||||
gsi::method ("error", (void (GenericDeviceExtractor::*) (const std::string &, const std::string &, const std::string &, const db::Polygon &)) &GenericDeviceExtractor::error,
|
||||
gsi::arg ("category_name"), gsi::arg ("category_description"), gsi::arg ("message"), gsi::arg ("geometry"),
|
||||
"@brief Issues an error with the given category name and description, message and databse-unit polygon geometry\n"
|
||||
"@brief Issues an error with the given category name and description, message and database-unit polygon geometry\n"
|
||||
),
|
||||
"@brief The basic class for implementing custom device extractors.\n"
|
||||
"\n"
|
||||
|
|
@ -376,7 +376,7 @@ Class<GenericDeviceExtractor> decl_GenericDeviceExtractor (decl_dbNetlistDeviceE
|
|||
" @li The layers used for the device extraction. These are input layers for the extraction as well as "
|
||||
" output layers for defining the terminals. Terminals are the poins at which the nets connect to the devices.\n"
|
||||
" Layers are defined using \\define_layer. Initially, layers are abstract definitions with a name and a description.\n"
|
||||
" Concrete layers will be given when defining the connectivitiy. @/li\n"
|
||||
" Concrete layers will be given when defining the connectivity. @/li\n"
|
||||
"@/ul\n"
|
||||
"\n"
|
||||
"When the device extraction is started, the device extraction algorithm will first ask the device extractor "
|
||||
|
|
@ -386,7 +386,7 @@ Class<GenericDeviceExtractor> decl_GenericDeviceExtractor (decl_dbNetlistDeviceE
|
|||
"implemented to produce the connectivity.\n"
|
||||
"\n"
|
||||
"Finally, the individual devices need to be extracted. Each cluster of connected shapes is presented to the "
|
||||
"device extractor. A cluster may include more than one device. It's the device extractor's responsibilty to "
|
||||
"device extractor. A cluster may include more than one device. It's the device extractor's responsibility to "
|
||||
"extract the devices from this cluster and deliver the devices through \\create_device. In addition, terminals "
|
||||
"have to be defined, so the net extractor can connect to the devices. Terminal definitions are made through "
|
||||
"\\define_terminal. The device extraction is implemented in the \\extract_devices method.\n"
|
||||
|
|
|
|||
|
|
@ -422,7 +422,7 @@ Class<db::DPath> decl_DPath ("db", "DPath",
|
|||
"@param accuracy The numerical accuracy of the computation\n"
|
||||
"\n"
|
||||
"The accuracy parameter controls the numerical resolution of the approximation process and should be in the "
|
||||
"order of half the database unit. This accuracy is used for suppressing redundant points and simplication of the "
|
||||
"order of half the database unit. This accuracy is used for suppressing redundant points and simplification of the "
|
||||
"resulting path.\n"
|
||||
"\n"
|
||||
"This method has been introduced in version 0.25."
|
||||
|
|
|
|||
|
|
@ -281,7 +281,7 @@ struct simple_polygon_defs
|
|||
"@param box The box to convert to a polygon\n"
|
||||
) +
|
||||
constructor ("ellipse", &ellipse, gsi::arg ("box"), gsi::arg ("n"),
|
||||
"@brief Creates a simple polygon appoximating an ellipse\n"
|
||||
"@brief Creates a simple polygon approximating an ellipse\n"
|
||||
"\n"
|
||||
"@param box The bounding box of the ellipse\n"
|
||||
"@param n The number of points that will be used to approximate the ellipse\n"
|
||||
|
|
@ -1125,7 +1125,7 @@ struct polygon_defs
|
|||
"@param box The box to convert to a polygon\n"
|
||||
) +
|
||||
constructor ("ellipse", &ellipse, gsi::arg ("box"), gsi::arg ("n"),
|
||||
"@brief Creates a simple polygon appoximating an ellipse\n"
|
||||
"@brief Creates a simple polygon approximating an ellipse\n"
|
||||
"\n"
|
||||
"@param box The bounding box of the ellipse\n"
|
||||
"@param n The number of points that will be used to approximate the ellipse\n"
|
||||
|
|
@ -1666,27 +1666,27 @@ static gsi::Methods make_po_constants ()
|
|||
{
|
||||
return
|
||||
constant ("PO_any", po_any,
|
||||
"@brief A value for the preferred orienation parameter of \\decompose_convex\n"
|
||||
"@brief A value for the preferred orientation parameter of \\decompose_convex\n"
|
||||
"This value indicates that there is not cut preference\n"
|
||||
"This constant has been introduced in version 0.25."
|
||||
) +
|
||||
constant ("PO_horizontal", po_horizontal,
|
||||
"@brief A value for the preferred orienation parameter of \\decompose_convex\n"
|
||||
"@brief A value for the preferred orientation parameter of \\decompose_convex\n"
|
||||
"This value indicates that there only horizontal cuts are allowed\n"
|
||||
"This constant has been introduced in version 0.25."
|
||||
) +
|
||||
constant ("PO_vertical", po_vertical,
|
||||
"@brief A value for the preferred orienation parameter of \\decompose_convex\n"
|
||||
"@brief A value for the preferred orientation parameter of \\decompose_convex\n"
|
||||
"This value indicates that there only vertical cuts are allowed\n"
|
||||
"This constant has been introduced in version 0.25."
|
||||
) +
|
||||
constant ("PO_htrapezoids", po_htrapezoids,
|
||||
"@brief A value for the preferred orienation parameter of \\decompose_convex\n"
|
||||
"@brief A value for the preferred orientation parameter of \\decompose_convex\n"
|
||||
"This value indicates that cuts shall favor decomposition into horizontal trapezoids\n"
|
||||
"This constant has been introduced in version 0.25."
|
||||
) +
|
||||
constant ("PO_vtrapezoids", po_vtrapezoids,
|
||||
"@brief A value for the preferred orienation parameter of \\decompose_convex\n"
|
||||
"@brief A value for the preferred orientation parameter of \\decompose_convex\n"
|
||||
"This value indicates that cuts shall favor decomposition into vertical trapezoids\n"
|
||||
"This constant has been introduced in version 0.25."
|
||||
);
|
||||
|
|
|
|||
|
|
@ -432,7 +432,7 @@ Class<db::RecursiveInstanceIterator> decl_RecursiveInstanceIterator ("db", "Recu
|
|||
"This moves the iterator to the next instance inside the search scope."
|
||||
) +
|
||||
gsi::method ("path", &db::RecursiveInstanceIterator::path,
|
||||
"@brief Gets the instantatiation path of the instance addressed currently\n"
|
||||
"@brief Gets the instantiation path of the instance addressed currently\n"
|
||||
"\n"
|
||||
"This attribute is a sequence of \\InstElement objects describing the cell instance path from the initial "
|
||||
"cell to the current instance. The path is empty if the current instance is in the top cell.\n"
|
||||
|
|
|
|||
|
|
@ -488,7 +488,7 @@ Class<db::RecursiveShapeIterator> decl_RecursiveShapeIterator ("db", "RecursiveS
|
|||
gsi::method_ext ("dtrans", &gsi::si_dtrans,
|
||||
"@brief Gets the transformation into the initial cell applicable for floating point types\n"
|
||||
"\n"
|
||||
"This transformation corresponds to the one deliverd by \\trans, but is applicable for "
|
||||
"This transformation corresponds to the one delivered by \\trans, but is applicable for "
|
||||
"the floating-point shape types in micron unit space.\n"
|
||||
"\n"
|
||||
"This method has been introduced in version 0.25.3."
|
||||
|
|
@ -522,7 +522,7 @@ Class<db::RecursiveShapeIterator> decl_RecursiveShapeIterator ("db", "RecursiveS
|
|||
"This method has been introduced in version 0.23."
|
||||
) +
|
||||
gsi::method ("path", &db::RecursiveShapeIterator::path,
|
||||
"@brief Gets the instantatiation path of the shape addressed currently\n"
|
||||
"@brief Gets the instantiation path of the shape addressed currently\n"
|
||||
"\n"
|
||||
"This attribute is a sequence of \\InstElement objects describing the cell instance path from the initial "
|
||||
"cell to the current cell containing the current shape.\n"
|
||||
|
|
@ -556,7 +556,7 @@ Class<db::RecursiveShapeIterator> decl_RecursiveShapeIterator ("db", "RecursiveS
|
|||
"while !iter.at_end?\n"
|
||||
" if iter.shape.renders_polygon?\n"
|
||||
" polygon = iter.shape.polygon.transformed(iter.itrans)\n"
|
||||
" puts \"In cell #{iter.cell.name}: \" + polyon.to_s\n"
|
||||
" puts \"In cell #{iter.cell.name}: \" + polygon.to_s\n"
|
||||
" end\n"
|
||||
" iter.next\n"
|
||||
"end\n"
|
||||
|
|
|
|||
|
|
@ -1102,7 +1102,7 @@ Class<db::Region> decl_Region (decl_dbShapeCollection, "db", "Region",
|
|||
) +
|
||||
method_ext ("with_bbox_aspect_ratio", with_bbox_aspect_ratio1, gsi::arg ("ratio"), gsi::arg ("inverse"),
|
||||
"@brief Filters the polygons by the aspect ratio of their bounding boxes\n"
|
||||
"Filters the polygons of the region by the apspect ratio of their bounding boxes. "
|
||||
"Filters the polygons of the region by the aspect ratio of their bounding boxes. "
|
||||
"The aspect ratio is the ratio of larger to smaller dimension of the bounding box. "
|
||||
"A square has an aspect ratio of 1.\n"
|
||||
"\n"
|
||||
|
|
@ -1115,7 +1115,7 @@ Class<db::Region> decl_Region (decl_dbShapeCollection, "db", "Region",
|
|||
) +
|
||||
method_ext ("with_bbox_aspect_ratio", with_bbox_aspect_ratio2, gsi::arg ("min_ratio"), gsi::arg ("max_ratio"), gsi::arg ("inverse"), gsi::arg ("min_included", true), gsi::arg ("max_included", true),
|
||||
"@brief Filters the polygons by the aspect ratio of their bounding boxes\n"
|
||||
"Filters the polygons of the region by the apspect ratio of their bounding boxes. "
|
||||
"Filters the polygons of the region by the aspect ratio of their bounding boxes. "
|
||||
"The aspect ratio is the ratio of larger to smaller dimension of the bounding box. "
|
||||
"A square has an aspect ratio of 1.\n"
|
||||
"\n"
|
||||
|
|
@ -1159,7 +1159,7 @@ Class<db::Region> decl_Region (decl_dbShapeCollection, "db", "Region",
|
|||
"This method has been introduced in version 0.27.\n"
|
||||
) +
|
||||
method_ext ("with_relative_height", with_relative_height1, gsi::arg ("ratio"), gsi::arg ("inverse"),
|
||||
"@brief Filters the polygons by the ratio of heigth to width\n"
|
||||
"@brief Filters the polygons by the ratio of height to width\n"
|
||||
"This method filters the polygons of the region by the ratio of height vs. width of their bounding boxes. "
|
||||
"'Tall' polygons have a large value while 'flat' polygons have a small value. A square has a relative height of 1.\n"
|
||||
"\n"
|
||||
|
|
@ -1300,7 +1300,7 @@ Class<db::Region> decl_Region (decl_dbShapeCollection, "db", "Region",
|
|||
method_ext ("insert", &insert_s, gsi::arg ("shapes"),
|
||||
"@brief Inserts all polygons from the shape collection into this region\n"
|
||||
"This method takes each \"polygon-like\" shape from the shape collection and "
|
||||
"insertes this shape into the region. Paths and boxes are converted to polygons during this process. "
|
||||
"inserts this shape into the region. Paths and boxes are converted to polygons during this process. "
|
||||
"Edges and text objects are ignored.\n"
|
||||
"\n"
|
||||
"This method has been introduced in version 0.25."
|
||||
|
|
@ -1308,7 +1308,7 @@ Class<db::Region> decl_Region (decl_dbShapeCollection, "db", "Region",
|
|||
method_ext ("insert", &insert_st<db::Trans>, gsi::arg ("shapes"), gsi::arg ("trans"),
|
||||
"@brief Inserts all polygons from the shape collection into this region with transformation\n"
|
||||
"This method takes each \"polygon-like\" shape from the shape collection and "
|
||||
"insertes this shape into the region after applying the given transformation. "
|
||||
"inserts this shape into the region after applying the given transformation. "
|
||||
"Paths and boxes are converted to polygons during this process. "
|
||||
"Edges and text objects are ignored.\n"
|
||||
"\n"
|
||||
|
|
@ -1317,7 +1317,7 @@ Class<db::Region> decl_Region (decl_dbShapeCollection, "db", "Region",
|
|||
method_ext ("insert", &insert_st<db::ICplxTrans>, gsi::arg ("shapes"), gsi::arg ("trans"),
|
||||
"@brief Inserts all polygons from the shape collection into this region with complex transformation\n"
|
||||
"This method takes each \"polygon-like\" shape from the shape collection and "
|
||||
"insertes this shape into the region after applying the given complex transformation. "
|
||||
"inserts this shape into the region after applying the given complex transformation. "
|
||||
"Paths and boxes are converted to polygons during this process. "
|
||||
"Edges and text objects are ignored.\n"
|
||||
"\n"
|
||||
|
|
@ -2158,7 +2158,7 @@ Class<db::Region> decl_Region (decl_dbShapeCollection, "db", "Region",
|
|||
) +
|
||||
method ("hulls", &db::Region::hulls,
|
||||
"@brief Returns the hulls of the region\n"
|
||||
"This method returns all hulls as polygons. The holes will be removed (filles). "
|
||||
"This method returns all hulls as polygons. The holes will be removed (filled). "
|
||||
"\n"
|
||||
"Merged semantics applies for this method (see \\merged_semantics= for a description of this concept)\n"
|
||||
"If merge semantics is not enabled, the hull may also enclose holes if the polygons "
|
||||
|
|
@ -2806,7 +2806,7 @@ Class<db::Region> decl_Region (decl_dbShapeCollection, "db", "Region",
|
|||
"This returns the number of raw polygons (not merged polygons if merged semantics is enabled).\n"
|
||||
"The count is computed 'as if flat', i.e. polygons inside a cell are multiplied by the number of times a cell is instantiated.\n"
|
||||
"\n"
|
||||
"The 'count' alias has been provided in version 0.26 to avoid ambiguitiy with the 'size' method which applies a geometrical bias."
|
||||
"The 'count' alias has been provided in version 0.26 to avoid ambiguity with the 'size' method which applies a geometrical bias."
|
||||
) +
|
||||
method ("hier_count", (size_t (db::Region::*) () const) &db::Region::hier_count,
|
||||
"@brief Returns the (hierarchical) number of polygons in the region\n"
|
||||
|
|
@ -2979,7 +2979,7 @@ gsi::EnumIn<db::Region, db::metrics_type> decl_Region_Metrics ("db", "Metrics",
|
|||
gsi::enum_const ("Square", db::Square,
|
||||
"@brief Specifies square metrics for the check functions\n"
|
||||
"This value can be used for the metrics parameter in the check functions, i.e. \\width_check. "
|
||||
"This value specifies sqaure metrics, i.e. the distance between two points is measured by:\n"
|
||||
"This value specifies square metrics, i.e. the distance between two points is measured by:\n"
|
||||
"\n"
|
||||
"@code\n"
|
||||
"d = max(abs(dx), abs(dy))\n"
|
||||
|
|
|
|||
|
|
@ -1588,7 +1588,7 @@ Class<db::Shape> decl_Shape ("db", "Shape",
|
|||
gsi::method_ext ("dsimple_polygon", &get_dsimple_polygon,
|
||||
"@brief Returns the simple polygon object in micrometer units\n"
|
||||
"\n"
|
||||
"Returns the simplep olygon object that this shape refers to or converts the object to a simplepolygon. "
|
||||
"Returns the simple polygon object that this shape refers to or converts the object to a simple polygon. "
|
||||
"The method returns the same object than \\simple_polygon, but translates it to micrometer units internally.\n"
|
||||
"\n"
|
||||
"This method has been introduced in version 0.25.\n"
|
||||
|
|
|
|||
|
|
@ -1051,7 +1051,7 @@ Class<db::DCplxTrans> decl_DCplxTrans ("db", "DCplxTrans",
|
|||
"to form the transformation which is equivalent to applying the second and then the first. Here is some code:\n"
|
||||
"\n"
|
||||
"@code\n"
|
||||
"# Create a transformation that applies a magnication of 1.5, a rotation by 90 degree\n"
|
||||
"# Create a transformation that applies a magnification of 1.5, a rotation by 90 degree\n"
|
||||
"# and displacement of 10 in x and 20 units in y direction:\n"
|
||||
"t = RBA::CplxTrans::new(1.5, 90, false, 10.0, 20.0)\n"
|
||||
"t.to_s # r90 *1.5 10,20\n"
|
||||
|
|
@ -1136,7 +1136,7 @@ Class<db::CplxTrans> decl_CplxTrans ("db", "CplxTrans",
|
|||
"to form the transformation which is equivalent to applying the second and then the first. Here is some code:\n"
|
||||
"\n"
|
||||
"@code\n"
|
||||
"# Create a transformation that applies a magnication of 1.5, a rotation by 90 degree\n"
|
||||
"# Create a transformation that applies a magnification of 1.5, a rotation by 90 degree\n"
|
||||
"# and displacement of 10 in x and 20 units in y direction:\n"
|
||||
"t = RBA::DCplxTrans::new(1.5, 90, false, 10.0, 20.0)\n"
|
||||
"t.to_s # r90 *1.5 10,20\n"
|
||||
|
|
@ -1217,7 +1217,7 @@ Class<db::ICplxTrans> decl_ICplxTrans ("db", "ICplxTrans",
|
|||
"to form the transformation which is equivalent to applying the second and then the first. Here is some code:\n"
|
||||
"\n"
|
||||
"@code\n"
|
||||
"# Create a transformation that applies a magnication of 1.5, a rotation by 90 degree\n"
|
||||
"# Create a transformation that applies a magnification of 1.5, a rotation by 90 degree\n"
|
||||
"# and displacement of 10 in x and 20 units in y direction:\n"
|
||||
"t = RBA::ICplxTrans::new(1.5, 90, false, 10.0, 20.0)\n"
|
||||
"t.to_s # r90 *1.5 10,20\n"
|
||||
|
|
@ -1297,7 +1297,7 @@ Class<db::VCplxTrans> decl_VCplxTrans ("db", "VCplxTrans",
|
|||
"to form the transformation which is equivalent to applying the second and then the first. Here is some code:\n"
|
||||
"\n"
|
||||
"@code\n"
|
||||
"# Create a transformation that applies a magnication of 1.5, a rotation by 90 degree\n"
|
||||
"# Create a transformation that applies a magnification of 1.5, a rotation by 90 degree\n"
|
||||
"# and displacement of 10 in x and 20 units in y direction:\n"
|
||||
"t = RBA::VCplxTrans::new(1.5, 90, false, 10, 20)\n"
|
||||
"t.to_s # r90 *1.5 10,20\n"
|
||||
|
|
|
|||
|
|
@ -68,10 +68,10 @@ namespace gsi
|
|||
" knots.size == control_points.size + degree + 1\n"
|
||||
"@/code\n"
|
||||
"\n"
|
||||
"The accuracy parameters allow tuing the resolution of the curve to target a specific approximation quality.\n"
|
||||
"The accuracy parameters allow tuning the resolution of the curve to target a specific approximation quality.\n"
|
||||
"\"relative_accuracy\" gives the accuracy relative to the local curvature radius, \"absolute\" accuracy gives the\n"
|
||||
"absolute accuracy. \"accuracy\" is the allowed deviation of polygon approximation from the ideal curve.\n"
|
||||
"The computed curve should meet at least one of the accurcay criteria. Setting both limits to a very small\n"
|
||||
"The computed curve should meet at least one of the accuracy criteria. Setting both limits to a very small\n"
|
||||
"value will result in long run times and a large number of points returned.\n"
|
||||
"\n"
|
||||
"This function supports both rational splines (NURBS) and non-rational splines. The latter use weights of\n"
|
||||
|
|
|
|||
Loading…
Reference in New Issue