Skip to content

Commit 0b57ecf

Browse files
committed
Codegen: add internal QLdoc to property templates
1 parent 2d34fec commit 0b57ecf

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

misc/codegen/templates/ql_class.mustache

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,9 @@ module Generated {
7171
* {{>ql_property_doc}} *
7272
* This includes nodes from the "hidden" AST. It can be overridden in subclasses to change the
7373
* behavior of both the `Immediate` and non-`Immediate` versions.
74+
{{#internal}}
75+
* INTERNAL: Do not use.
76+
{{/internal}}
7477
*/
7578
{{type}} get{{#is_unordered}}An{{/is_unordered}}Immediate{{singular}}({{#is_indexed}}int index{{/is_indexed}}) {
7679
{{^synth}}
@@ -86,6 +89,9 @@ module Generated {
8689
{{#description}}
8790
* {{.}}
8891
{{/description}}
92+
{{#internal}}
93+
* INTERNAL: Do not use.
94+
{{/internal}}
8995
*/
9096
final {{type}} {{getter}}({{#is_indexed}}int index{{/is_indexed}}) {
9197
exists({{type}} immediate | immediate = this.get{{#is_unordered}}An{{/is_unordered}}Immediate{{singular}}({{#is_indexed}}index{{/is_indexed}}) and
@@ -99,6 +105,9 @@ module Generated {
99105
{{#description}}
100106
* {{.}}
101107
{{/description}}
108+
{{#internal}}
109+
* INTERNAL: Do not use.
110+
{{/internal}}
102111
*/
103112
{{type}} {{getter}}({{#is_indexed}}int index{{/is_indexed}}) {
104113
{{^synth}}
@@ -113,6 +122,9 @@ module Generated {
113122
{{#is_optional}}
114123
/**
115124
* Holds if `{{getter}}({{#is_repeated}}index{{/is_repeated}})` exists.
125+
{{#internal}}
126+
* INTERNAL: Do not use.
127+
{{/internal}}
116128
*/
117129
final predicate has{{singular}}({{#is_repeated}}int index{{/is_repeated}}) {
118130
exists(this.{{getter}}({{#is_repeated}}index{{/is_repeated}}))
@@ -122,6 +134,9 @@ module Generated {
122134

123135
/**
124136
* Gets any of the {{doc_plural}}.
137+
{{#internal}}
138+
* INTERNAL: Do not use.
139+
{{/internal}}
125140
*/
126141
final {{type}} {{indefinite_getter}}() {
127142
result = this.{{getter}}(_)
@@ -130,6 +145,9 @@ module Generated {
130145

131146
/**
132147
* Gets the number of {{doc_plural}}.
148+
{{#internal}}
149+
* INTERNAL: Do not use.
150+
{{/internal}}
133151
*/
134152
final int getNumberOf{{plural}}() {
135153
result = count(int i | exists(this.{{getter}}(i)))
@@ -139,6 +157,9 @@ module Generated {
139157
{{#is_unordered}}
140158
/**
141159
* Gets the number of {{doc_plural}}.
160+
{{#internal}}
161+
* INTERNAL: Do not use.
162+
{{/internal}}
142163
*/
143164
final int getNumberOf{{plural}}() {
144165
result = count(this.{{getter}}())

0 commit comments

Comments
 (0)