From 44ef026f1c7312ce99bacf44e070370a56505822 Mon Sep 17 00:00:00 2001 From: Alex Shvartzkop Date: Tue, 5 Aug 2025 15:05:58 +0300 Subject: [PATCH] Update generated custom DRC rules help files, required for Weblate. --- ...l_setup_rules_help_8expression_functions.h | 227 +++++++++--------- 1 file changed, 111 insertions(+), 116 deletions(-) diff --git a/pcbnew/dialogs/panel_setup_rules_help_8expression_functions.h b/pcbnew/dialogs/panel_setup_rules_help_8expression_functions.h index 483f637bdf..8ef0312d74 100644 --- a/pcbnew/dialogs/panel_setup_rules_help_8expression_functions.h +++ b/pcbnew/dialogs/panel_setup_rules_help_8expression_functions.h @@ -1,118 +1,113 @@ // Do not edit this file, it is autogenerated by CMake from the .md file _HKI( "### Expression functions\n" - "\n" - "All function parameters support simple wildcards (`*` and `?`).\n" - "

\n" - "\n" - " A.enclosedByArea('')\n" - "True if all of `A` lies within the given zone's outline.\n" - "\n" - "NB: this is potentially a more expensive call than `intersectsArea()`. Use " - "`intersectsArea()`\n" - "where possible.\n" - "

\n" - "\n" - " A.existsOnLayer('')\n" - "True if `A` exists on the given layer. The layer name can be\n" - "either the name assigned in Board Setup > Board Editor Layers or\n" - "the canonical name (ie: `F.Cu`).\n" - "\n" - "NB: this returns true if `A` is on the given layer, independently\n" - "of whether or not the rule is being evaluated for that layer.\n" - "For the latter use a `(layer \"layer_name\")` clause in the rule.\n" - "

\n" - "\n" - " A.fromTo('x', 'y')\n" - "True if the object exists on the copper path between the given \n" - "pads. `x` and `y` are the full names of pads in the design, such as \n" - "`R1-Pad1`.\n" - "

\n" - "\n" - " A.getField('')\n" - "The value of the given field. Only footprints have fields, so a field is only returned if\n" - "`A` is a footprint.\n" - "

\n" - "\n" - " A.hasComponentClass('')\n" - "True if the set of component classes assigned to `A` contains the named \n" - "component class.\n" - "

\n" - "\n" - " A.hasNetclass('')\n" - "True if `A` has had the given netclass assigned to it, either by an explicit netclass " - "label\n" - "or through a pattern match assignment.\n" - "

\n" - "\n" - " A.inDiffPair('')\n" - "True if `A` has a net that is part of the specified differential pair.\n" - "`` is the base name of the differential pair. For example, `inDiffPair('/CLK')`\n" - "matches items in the `/CLK_P` and `/CLK_N` nets.\n" - "

\n" - "\n" - " A.intersectsArea('')\n" - "True if any part of `A` lies within the given zone's outline.\n" - "

\n" - "\n" - " A.intersectsCourtyard('')\n" - "True if any part of `A` lies within the given footprint's principal courtyard.\n" - "

\n" - "\n" - " A.intersectsFrontCourtyard('')\n" - "True if any part of `A` lies within the given footprint's front courtyard.\n" - "

\n" - "\n" - " A.intersectsBackCourtyard('')\n" - "True if any part of `A` lies within the given footprint's back courtyard.\n" - "

\n" - "\n" - "The `footprint_identifier` listed above can be one of the following:\n" - "\n" - "1. A reference designator, possibly containing wildcards `*` and `?`\n" - "2. A footprint library identifier such as `LibName:FootprintName`. In this case,\n" - " the library identifier must contain the `:` character to separate the library\n" - " name from the footprint name, and either name may contain wildcards.\n" - "3. A component class, in the form `${Class:ClassName}`. The keyword `Class` is not\n" - " case-sensitive, but component class names are case-sensitive.\n" - "\n" - "
\n" - "\n" - " A.isBlindBuriedVia()\n" - "True if `A` is a blind/buried via.\n" - "

\n" - "\n" - " AB.isCoupledDiffPair()\n" - "True if `A` and `B` are members of the same diff pair.\n" - "

\n" - "\n" - " A.isMicroVia()\n" - "True if `A` is a microvia.\n" - "

\n" - "\n" - " A.isPlated()\n" - "True if `A` has a hole which is plated.\n" - "

\n" - "\n" - " A.memberOfGroup('')\n" - "True if `A` is a member of the given group. The name can contain wildcards.\n" - "Includes nested membership.\n" - "

\n" - "\n" - " A.memberOfFootprint('')\n" - "True if `A` is a member of a given footprint (for example, a pad or graphic shape defined\n" - "inside that footprint). The various ways of specifying `footprint_identifier` are " - "described above.\n" - "

\n" - "\n" - " A.memberOfSheet('')\n" - "True if `A` is a member of the given schematic sheet. The sheet path can contain " - "wildcards.\n" - "

\n" - "\n" - " A.memberOfSheetOrChildren('')\n" - "True if `A` is a member of the given schematic sheet, or any of its child hierarchical " - "sheets. The sheet path can \n" - "contain wildcards.\n" - "

\n" - "\n" - "" ); +"\n" +"All function parameters support simple wildcards (`*` and `?`).\n" +"

\n" +"\n" +" A.enclosedByArea('')\n" +"True if all of `A` lies within the given zone's outline.\n" +"\n" +"NB: this is potentially a more expensive call than `intersectsArea()`. Use `intersectsArea()`\n" +"where possible.\n" +"

\n" +"\n" +" A.existsOnLayer('')\n" +"True if `A` exists on the given layer. The layer name can be\n" +"either the name assigned in Board Setup > Board Editor Layers or\n" +"the canonical name (ie: `F.Cu`).\n" +"\n" +"NB: this returns true if `A` is on the given layer, independently\n" +"of whether or not the rule is being evaluated for that layer.\n" +"For the latter use a `(layer \"layer_name\")` clause in the rule.\n" +"

\n" +"\n" +" A.fromTo('x', 'y')\n" +"True if the object exists on the copper path between the given \n" +"pads. `x` and `y` are the full names of pads in the design, such as \n" +"`R1-Pad1`.\n" +"

\n" +"\n" +" A.getField('')\n" +"The value of the given field. Only footprints have fields, so a field is only returned if\n" +"`A` is a footprint.\n" +"

\n" +"\n" +" A.hasComponentClass('')\n" +"True if the set of component classes assigned to `A` contains the named \n" +"component class.\n" +"

\n" +"\n" +" A.hasNetclass('')\n" +"True if `A` has had the given netclass assigned to it, either by an explicit netclass label\n" +"or through a pattern match assignment.\n" +"

\n" +"\n" +" A.inDiffPair('')\n" +"True if `A` has a net that is part of the specified differential pair.\n" +"`` is the base name of the differential pair. For example, `inDiffPair('/CLK')`\n" +"matches items in the `/CLK_P` and `/CLK_N` nets.\n" +"

\n" +"\n" +" A.intersectsArea('')\n" +"True if any part of `A` lies within the given zone's outline.\n" +"

\n" +"\n" +" A.intersectsCourtyard('')\n" +"True if any part of `A` lies within the given footprint's principal courtyard.\n" +"

\n" +"\n" +" A.intersectsFrontCourtyard('')\n" +"True if any part of `A` lies within the given footprint's front courtyard.\n" +"

\n" +"\n" +" A.intersectsBackCourtyard('')\n" +"True if any part of `A` lies within the given footprint's back courtyard.\n" +"

\n" +"\n" +"The `footprint_identifier` listed above can be one of the following:\n" +"\n" +"1. A reference designator, possibly containing wildcards `*` and `?`\n" +"2. A footprint library identifier such as `LibName:FootprintName`. In this case,\n" +" the library identifier must contain the `:` character to separate the library\n" +" name from the footprint name, and either name may contain wildcards.\n" +"3. A component class, in the form `${Class:ClassName}`. The keyword `Class` is not\n" +" case-sensitive, but component class names are case-sensitive.\n" +"\n" +"
\n" +"\n" +" A.isBlindBuriedVia()\n" +"True if `A` is a blind/buried via.\n" +"

\n" +"\n" +" AB.isCoupledDiffPair()\n" +"True if `A` and `B` are members of the same diff pair.\n" +"

\n" +"\n" +" A.isMicroVia()\n" +"True if `A` is a microvia.\n" +"

\n" +"\n" +" A.isPlated()\n" +"True if `A` has a hole which is plated.\n" +"

\n" +"\n" +" A.memberOfGroup('')\n" +"True if `A` is a member of the given group. The name can contain wildcards.\n" +"Includes nested membership.\n" +"

\n" +"\n" +" A.memberOfFootprint('')\n" +"True if `A` is a member of a given footprint (for example, a pad or graphic shape defined\n" +"inside that footprint). The various ways of specifying `footprint_identifier` are described above.\n" +"

\n" +"\n" +" A.memberOfSheet('')\n" +"True if `A` is a member of the given schematic sheet. The sheet path can contain wildcards.\n" +"

\n" +"\n" +" A.memberOfSheetOrChildren('')\n" +"True if `A` is a member of the given schematic sheet, or any of its child hierarchical sheets. The sheet path can \n" +"contain wildcards.\n" +"

\n" +"\n" +"" );