Hardcode documentation for the synthetic Enum.entries property #3071
Conversation
| Returns a representation of an immutable list of all enum entries, in the order they're declared. | ||
|
|
||
| This method may be used to iterate over the enum entries. |
There was a problem hiding this comment.
I didn't find the documentation text in the KEEP, and entries hasn't been documented anywhere else, so I decided to play it safe and stick to the short description similar to the values() function for now.
Should be discussed with @qwwdfsad and the libraries team, maybe there's a KDoc lying around somewhere, or the authors know how they want to document it.
There was a problem hiding this comment.
No KDoc around, unfortunately, the proposed approach is the intended one.
I'm in general good with the documentation template, thanks for taking care 👍
|
As a side note: I noticed that Dokka is unable to parse the KDocs for Screenshoteven though they are present in Enum's source code. I tried to address it in this PR, but realized it wasn't a simple fix, so I think it should be addressed separately. TLDR is that both Should try it with K2 - maybe it's been fixed there already. |
This is like #463. The compiler knows nothing about the source code of builtins. |
They are fake overrides for enums and entries. |
| Returns a representation of an immutable list of all enum entries, in the order they're declared. | ||
|
|
||
| This method may be used to iterate over the enum entries. |
There was a problem hiding this comment.
No KDoc around, unfortunately, the proposed approach is the intended one.
I'm in general good with the documentation template, thanks for taking care 👍
Oh yeah, indeed, thanks for taking a look! I noticed that they weren't ignored, so I assumed that the result of the isObvious check was It looks like we need to rename |
(cherry picked from commit 72541d1)
Fixes #2762