Fixed a typo in DRC doc of 'corners'

This commit is contained in:
Matthias Koefferlein 2024-02-21 22:17:24 +01:00
parent 4789e2effb
commit f7411b52d2
11 changed files with 25 additions and 29 deletions

View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE language SYSTEM "klayout_doc.dtd"> <!DOCTYPE language SYSTEM "klayout_doc.dtd">
<!-- generated by /home/matthias/klayout/0.28/scripts/drc_lvs_doc/extract_doc.rb --> <!-- generated by /home/matthias/klayout/master/scripts/drc_lvs_doc/extract_doc.rb -->
<!-- DO NOT EDIT! --> <!-- DO NOT EDIT! -->
<doc> <doc>

View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE language SYSTEM "klayout_doc.dtd"> <!DOCTYPE language SYSTEM "klayout_doc.dtd">
<!-- generated by /home/matthias/klayout/0.28/scripts/drc_lvs_doc/extract_doc.rb --> <!-- generated by /home/matthias/klayout/master/scripts/drc_lvs_doc/extract_doc.rb -->
<!-- DO NOT EDIT! --> <!-- DO NOT EDIT! -->
<doc> <doc>
@ -358,7 +358,7 @@ The plain function is equivalent to "primary.bbox_width".
This method acts on edge expressions and delivers a specific part of each edge. This method acts on edge expressions and delivers a specific part of each edge.
See <a href="/about/drc_ref_layer.xml#centers">layer#centers</a> for details about this functionality. See <a href="/about/drc_ref_layer.xml#centers">layer#centers</a> for details about this functionality.
</p> </p>
<a name="corners"/><h2>"corners" - Applies smoothing</h2> <a name="corners"/><h2>"corners" - Selects corners of polygons</h2>
<keyword name="corners"/> <keyword name="corners"/>
<p>Usage:</p> <p>Usage:</p>
<ul> <ul>
@ -369,8 +369,10 @@ See <a href="/about/drc_ref_layer.xml#centers">layer#centers</a> for details abo
<p> <p>
This operation acts on polygons and selects the corners of the polygons. This operation acts on polygons and selects the corners of the polygons.
It can be put into a condition to select corners by their angles. The angle of It can be put into a condition to select corners by their angles. The angle of
a corner is positive for a turn to the left if walking a polygon counterclockwise a corner is positive for a turn to the left if walking a polygon clockwise
and negative for the turn to the right. Angles take values between -180 and 180 degree. and negative for the turn to the right. Hence positive angles indicate concave
(inner) corners, negative ones indicate convex (outer) corners.
Angles take values between -180 and 180 degree.
</p><p> </p><p>
When using "as_dots" for the argument, the operation will return single-point edges at When using "as_dots" for the argument, the operation will return single-point edges at
the selected corners. With "as_boxes" (the default), small (2x2 DBU) rectangles will be the selected corners. With "as_boxes" (the default), small (2x2 DBU) rectangles will be
@ -386,8 +388,8 @@ out = in.drc(primary.corners) # equivalent
The following example selects all inner corners: The following example selects all inner corners:
</p><p> </p><p>
<pre> <pre>
out = in.drc(corners &lt; 0) out = in.drc(corners &gt; 0)
out = in.drc(primary.corners &lt; 0) # equivalent out = in.drc(primary.corners &gt; 0) # equivalent
</pre> </pre>
</p><p> </p><p>
The "corners" method is available as a plain function or as a method on <a href="/about/drc_ref_drc.xml">DRC</a> expressions. The "corners" method is available as a plain function or as a method on <a href="/about/drc_ref_drc.xml">DRC</a> expressions.

View File

@ -1,17 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE language SYSTEM "klayout_doc.dtd"> <!DOCTYPE language SYSTEM "klayout_doc.dtd">
<!-- generated by /home/matthias/klayout/0.28/scripts/drc_lvs_doc/extract_doc.rb --> <!-- generated by /home/matthias/klayout/master/scripts/drc_lvs_doc/extract_doc.rb -->
<!-- DO NOT EDIT! --> <!-- DO NOT EDIT! -->
<doc> <doc>
<title>DRC Reference: Global Functions</title> <title>DRC Reference: Global Functions</title>
<keyword name="global"/> <keyword name="global"/>
<p>
Some functions are available on global level and can be used without any object.
Most of them are convenience functions that basically act on some default object
or provide function-like alternatives for the methods.
</p>
<h2-index/> <h2-index/>
<a name="angle"/><h2>"angle" - In universal DRC context: selects edges based on their orientation</h2> <a name="angle"/><h2>"angle" - In universal DRC context: selects edges based on their orientation</h2>
<keyword name="angle"/> <keyword name="angle"/>

View File

@ -1,15 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE language SYSTEM "klayout_doc.dtd"> <!DOCTYPE language SYSTEM "klayout_doc.dtd">
<!-- generated by /home/matthias/klayout/0.28/scripts/drc_lvs_doc/extract_doc.rb --> <!-- generated by /home/matthias/klayout/master/scripts/drc_lvs_doc/extract_doc.rb -->
<!-- DO NOT EDIT! --> <!-- DO NOT EDIT! -->
<doc> <doc>
<title>DRC Reference: Layer Object</title> <title>DRC Reference: Layer Object</title>
<keyword name="Layer"/> <keyword name="Layer"/>
<p>
The layer object represents a collection of polygons, edges or edge pairs.
</p>
<h2-index/> <h2-index/>
<a name="&amp;"/><h2>"&amp;" - Boolean AND operation</h2> <a name="&amp;"/><h2>"&amp;" - Boolean AND operation</h2>
<keyword name="&amp;"/> <keyword name="&amp;"/>
@ -268,7 +265,7 @@ deliver objects that can be converted into polygons. Such objects are of class <
This method produces markers on the corners of the polygons. An angle criterion can be given which This method produces markers on the corners of the polygons. An angle criterion can be given which
selects corners based on the angle of the connecting edges. Positive angles indicate a left turn selects corners based on the angle of the connecting edges. Positive angles indicate a left turn
while negative angles indicate a right turn. Since polygons are oriented clockwise, positive angles while negative angles indicate a right turn. Since polygons are oriented clockwise, positive angles
indicate concave corners while negative ones indicate convex corners. indicate concave (inner) corners while negative ones indicate convex (outer) corners
</p><p> </p><p>
The markers generated can be point-like edges or small 2x2 DBU boxes. The latter is the default. The markers generated can be point-like edges or small 2x2 DBU boxes. The latter is the default.
</p><p> </p><p>

View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE language SYSTEM "klayout_doc.dtd"> <!DOCTYPE language SYSTEM "klayout_doc.dtd">
<!-- generated by /home/matthias/klayout/0.28/scripts/drc_lvs_doc/extract_doc.rb --> <!-- generated by /home/matthias/klayout/master/scripts/drc_lvs_doc/extract_doc.rb -->
<!-- DO NOT EDIT! --> <!-- DO NOT EDIT! -->
<doc> <doc>

View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE language SYSTEM "klayout_doc.dtd"> <!DOCTYPE language SYSTEM "klayout_doc.dtd">
<!-- generated by /home/matthias/klayout/0.28/scripts/drc_lvs_doc/extract_doc.rb --> <!-- generated by /home/matthias/klayout/master/scripts/drc_lvs_doc/extract_doc.rb -->
<!-- DO NOT EDIT! --> <!-- DO NOT EDIT! -->
<doc> <doc>

View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE language SYSTEM "klayout_doc.dtd"> <!DOCTYPE language SYSTEM "klayout_doc.dtd">
<!-- generated by /home/matthias/klayout/0.28/scripts/drc_lvs_doc/extract_doc.rb --> <!-- generated by /home/matthias/klayout/master/scripts/drc_lvs_doc/extract_doc.rb -->
<!-- DO NOT EDIT! --> <!-- DO NOT EDIT! -->
<doc> <doc>

View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE language SYSTEM "klayout_doc.dtd"> <!DOCTYPE language SYSTEM "klayout_doc.dtd">
<!-- generated by /home/matthias/klayout/0.28/scripts/drc_lvs_doc/extract_doc.rb --> <!-- generated by /home/matthias/klayout/master/scripts/drc_lvs_doc/extract_doc.rb -->
<!-- DO NOT EDIT! --> <!-- DO NOT EDIT! -->
<doc> <doc>

View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE language SYSTEM "klayout_doc.dtd"> <!DOCTYPE language SYSTEM "klayout_doc.dtd">
<!-- generated by /home/matthias/klayout/0.28/scripts/drc_lvs_doc/extract_doc.rb --> <!-- generated by /home/matthias/klayout/master/scripts/drc_lvs_doc/extract_doc.rb -->
<!-- DO NOT EDIT! --> <!-- DO NOT EDIT! -->
<doc> <doc>

View File

@ -756,15 +756,17 @@ CODE
# %DRC% # %DRC%
# @name corners # @name corners
# @brief Applies smoothing # @brief Selects corners of polygons
# @synopsis expression.corners # @synopsis expression.corners
# @synopsis expression.corners(as_dots) # @synopsis expression.corners(as_dots)
# @synopsis expression.corners(as_boxes) # @synopsis expression.corners(as_boxes)
# #
# This operation acts on polygons and selects the corners of the polygons. # This operation acts on polygons and selects the corners of the polygons.
# It can be put into a condition to select corners by their angles. The angle of # It can be put into a condition to select corners by their angles. The angle of
# a corner is positive for a turn to the left if walking a polygon counterclockwise # a corner is positive for a turn to the left if walking a polygon clockwise
# and negative for the turn to the right. Angles take values between -180 and 180 degree. # and negative for the turn to the right. Hence positive angles indicate concave
# (inner) corners, negative ones indicate convex (outer) corners.
# Angles take values between -180 and 180 degree.
# #
# When using "as_dots" for the argument, the operation will return single-point edges at # When using "as_dots" for the argument, the operation will return single-point edges at
# the selected corners. With "as_boxes" (the default), small (2x2 DBU) rectangles will be # the selected corners. With "as_boxes" (the default), small (2x2 DBU) rectangles will be
@ -780,8 +782,8 @@ CODE
# The following example selects all inner corners: # The following example selects all inner corners:
# #
# @code # @code
# out = in.drc(corners < 0) # out = in.drc(corners > 0)
# out = in.drc(primary.corners < 0) # equivalent # out = in.drc(primary.corners > 0) # equivalent
# @/code # @/code
# #
# The "corners" method is available as a plain function or as a method on \DRC# expressions. # The "corners" method is available as a plain function or as a method on \DRC# expressions.

View File

@ -1232,7 +1232,7 @@ CODE
# This method produces markers on the corners of the polygons. An angle criterion can be given which # This method produces markers on the corners of the polygons. An angle criterion can be given which
# selects corners based on the angle of the connecting edges. Positive angles indicate a left turn # selects corners based on the angle of the connecting edges. Positive angles indicate a left turn
# while negative angles indicate a right turn. Since polygons are oriented clockwise, positive angles # while negative angles indicate a right turn. Since polygons are oriented clockwise, positive angles
# indicate concave corners while negative ones indicate convex corners. # indicate concave (inner) corners while negative ones indicate convex (outer) corners
# #
# The markers generated can be point-like edges or small 2x2 DBU boxes. The latter is the default. # The markers generated can be point-like edges or small 2x2 DBU boxes. The latter is the default.
# #