Swift: add more doc strings to generated things - #14715
Conversation
geoffw0
left a comment
geoffw0
left a comment
There was a problem hiding this comment.
LGTM (I checked the generation code and a sample of the generated comments). These are a bit repetitive, but I think will really help a reader who hasn't figured out what each type of file is for already.
| // generated by {{generator}}, remove this comment if you wish to edit this file | ||
| /** | ||
| * This module provides a hand-modifiable wrapper around the generated class `{{name}}`. | ||
| {{#ql_internal}} |
There was a problem hiding this comment.
I'm not sure ql_internal is part of the Stub?
There was a problem hiding this comment.
good catch! And it made me think, that all the generated classes should actually be marked INTERNAL, as they should never be used directly, so I changed that as well.
There was a problem hiding this comment.
But methods from generated classes are used all the time and thus should not be marked as internal, right? For example Callable.getName() is from Generated::Callable.
There was a problem hiding this comment.
exactly. Unless ql.internal is used on a specific property (for example kind: int | ql.internal), getters are not marked as internal.
The conflict was there on |
3 participants
Also, all files under
generatedand their classes are now markedINTERNALregardless of theql.internalpragma, as they should never be used directly (a user should not writeGenerated::Bla).