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

Exposing more project settings for documentation #74727

Merged
merged 1 commit into from
Mar 15, 2023

Conversation

AThousandShips
Copy link
Member

@AThousandShips AThousandShips commented Mar 10, 2023

For project settings to be available for documentation, more importantly for doctool and ci to work, they have to be defined before this line:

doc.generate(doc_base);

Moved a number of settings from below this to project_settings.cpp, could also move them inside main.cpp but felt this was a better place to put them, can also move other settings out of main but left ones not causing this problem to keep the changes minimal

Documented a few of the settings that I had a clear idea of what they did and how to explain.

@AThousandShips AThousandShips requested review from a team as code owners March 10, 2023 15:35
@AThousandShips
Copy link
Member Author

AThousandShips commented Mar 11, 2023

I think the settings should be in a proper order now

Copy link
Contributor

@YuriSizov YuriSizov left a comment

Choose a reason for hiding this comment

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

Couple of suggestions for the descriptions themselves, but LGTM otherwise.

@AThousandShips
Copy link
Member Author

Went ahead and updated the documentation in SceneTree as well as some descriptions were taken straight from there.

@AThousandShips
Copy link
Member Author

Identified a few more settings, editor related all of them, that still are inaccessible to documentation, will investigate if I can expose them.

@AThousandShips
Copy link
Member Author

Went through and it looks like all settings in the ProjectSettings menu are now documented or possible to document, that was one tedious slog

If someone else wants to entertain themselves by looking if settings are exposed you can simply add something like "EMPTY" to the descriptions of all properties in ProjectSettings, which makes it stick out if its unexposed, then it will just say the usual "no desc" or something.

@YuriSizov YuriSizov merged commit 3596443 into godotengine:master Mar 15, 2023
@YuriSizov
Copy link
Contributor

Thanks!

@AThousandShips
Copy link
Member Author

Thank you!

@AThousandShips AThousandShips deleted the project_settings branch March 15, 2023 15:00
@YuriSizov
Copy link
Contributor

Cherry-picked for 4.0.2.

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.

3 participants