Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation to JavaClass & JavaClassWrapper #86839

Merged
merged 1 commit into from
Apr 8, 2024

Conversation

Mickeon
Copy link
Contributor

@Mickeon Mickeon commented Jan 5, 2024

Related to #22136.

I... seriously don't know. I am struggling to understand the meaning of them. Any mention of these is outstandingly lacking, as if hidden in ancient scrolls. The code is old, uncommented and a bit garbled, and the history on GitHub doesn't tell me anything. Even the Android devs aren't exactly sure what these are for: JNISingleton exists and the tutorial for it is sufficient, at least.

Ever since their introduction they've been left ignored lacking any sort of documentation or proper tutorial. What's the purpose of these? Their obscurity stood out to me like a sore thumb. I had to know, and fill them with some semblance of information. Hence, I have written my... best guesses.

@Mickeon Mickeon requested a review from a team as a code owner January 5, 2024 16:21
@Mickeon Mickeon force-pushed the java-class-documentation branch from f31585a to 26a9b3e Compare January 5, 2024 16:22
@AThousandShips AThousandShips added this to the 4.x milestone Jan 5, 2024
@Mickeon Mickeon force-pushed the java-class-documentation branch from 26a9b3e to b9551c1 Compare January 5, 2024 16:24
@Mickeon Mickeon force-pushed the java-class-documentation branch from b9551c1 to 1310dd0 Compare January 5, 2024 18:54
Copy link
Member

@mhilbrunner mhilbrunner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Maybe this is the ex-Java dev in me talking, but these seem reasonable enough to me :)

@akien-mga akien-mga modified the milestones: 4.x, 4.3 Apr 7, 2024
@akien-mga akien-mga merged commit 84a372d into godotengine:master Apr 8, 2024
15 checks passed
@akien-mga
Copy link
Member

Thanks!

@Mickeon Mickeon deleted the java-class-documentation branch June 6, 2024 12:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants