Skip to content

Commit 10afa43

Browse files
committed
Swift: add more doc strings to generated things
1 parent c6bc1a3 commit 10afa43

File tree

657 files changed

+4638
-651
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

657 files changed

+4638
-651
lines changed

misc/codegen/templates/ql_class.mustache

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
// generated by {{generator}}
2+
/**
3+
* This module provides the generated definition of `{{name}}`.
4+
{{#ql_internal}}
5+
* INTERNAL: Do not use.
6+
{{/ql_internal}}
7+
*/
8+
29
private import {{import_prefix}}.Synth
310
private import {{import_prefix}}.Raw
411
{{#imports}}
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
// generated by {{generator}}
2+
/**
3+
* This module exports all modules providing `Element` subclasses.
4+
*/
5+
26
{{#imports}}
37
import {{.}}
48
{{/imports}}

misc/codegen/templates/ql_parent.mustache

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
// generated by {{generator}}
2+
/**
3+
* This module provides the generated parent/child relationship.
4+
*/
25

36
{{#imports}}
47
import {{.}}

misc/codegen/templates/ql_stub.mustache

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
11
// generated by {{generator}}, remove this comment if you wish to edit this file
2+
/**
3+
* This module provides a hand-modifiable wrapper around the generated class `{{name}}`.
4+
{{#ql_internal}}
5+
* INTERNAL: Do not use.
6+
{{/ql_internal}}
7+
*/
28
private import {{base_import}}
39
{{#has_synth_accessors}}
410
private import {{import_prefix}}.Raw

misc/codegen/templates/ql_synth_constructor_stub.mustache

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
// generated by {{generator}}, remove this comment if you wish to edit this file
2+
/**
3+
* This module defines the hook used internally to tweak the characteristic predicate of
4+
* `{{cls.name}}` synthesized instances.
5+
* INTERNAL: Do not use.
6+
*/
27
private import {{import_prefix}}.Raw
38
{{#cls}}
49
{{#is_db}}
@@ -7,6 +12,10 @@ private import {{import_prefix}}.PureSynthConstructors
712
{{/has_subtracted_synth_types}}
813
{{/is_db}}
914

15+
/**
16+
* The characteristic predicate of `{{name}}` synthesized instances.
17+
* INTERNAL: Do not use.
18+
*/
1019
predicate construct{{name}}({{#params}}{{^first}}, {{/first}}{{type}} {{param}}{{/params}}) {
1120
{{#is_db}}
1221
{{#subtracted_synth_types}}{{^first}} and {{/first}}not construct{{name}}(id){{/subtracted_synth_types}}

swift/ql/.generated.list

Lines changed: 651 additions & 651 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

swift/ql/lib/codeql/swift/elements.qll

Lines changed: 4 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

swift/ql/lib/codeql/swift/elements/AvailabilityInfoConstructor.qll

Lines changed: 10 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

swift/ql/lib/codeql/swift/elements/AvailabilitySpec.qll

Lines changed: 4 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

swift/ql/lib/codeql/swift/elements/CommentConstructor.qll

Lines changed: 10 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)