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.

Sign up for GitHub

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

Jump to bottom

Docs comments do not show up if only some of the class members/methods are documented #810

Closed
RedMser opened this issue Jul 23, 2024 · 0 comments · Fixed by #815
Closed

Docs comments do not show up if only some of the class members/methods are documented #810

RedMser opened this issue Jul 23, 2024 · 0 comments · Fixed by #815
Labels
bug c: register Register classes, functions and other symbols to GDScript

Comments

@RedMser
Copy link

RedMser commented Jul 23, 2024

Newest master allows for documentation comments like /// Hello to be included in Godot's documentation view.

It has a bug that, if you have e.g. two methods exposed to the API, but only one of them is documented, then neither of the docs show up in the documentation view. You must document every public API for it to show up properly.

Repro project, see readme for images and step by step: https://github.com/RedMser/bug-repro-godot-rust-docs
@Bromeon Bromeon added bug c: register Register classes, functions and other symbols to GDScript labels Jul 23, 2024
Yarwin added a commit to Yarwin/gdext that referenced this issue Jul 26, 2024
@Yarwin
godot-rust#810 Docs comments do not show up if only some of the class…
92739b9 
… members/methods are documented

- Extend test case to feature some undocumented members of godot instances
- Change map&unwrap in docs.rs to filter_map
- Add "docs" feature to plugin in constant_tests
@Yarwin Yarwin mentioned this issue Jul 26, 2024
Merged
Yarwin added a commit to Yarwin/gdext that referenced this issue Jul 26, 2024
@Yarwin
godot-rust#810 Docs comments do not show up if only some of the class…
5a81f7f 
… members/methods are documented

- Extend test case to feature some undocumented members of godot instances
- Change map&unwrap in docs.rs to filter_map
- Add "docs" feature to plugin in constant_tests
Yarwin added a commit to Yarwin/gdext that referenced this issue Jul 26, 2024
@Yarwin
godot-rust#810 Docs comments do not show up if only some of the class…
750f68b 
… members/methods are documented

- Don't generate TokenStream for undocumented functions
- Remove leftover from itest
@RedMser RedMser mentioned this issue Jul 26, 2024
Merged
4 tasks
Yarwin added a commit to Yarwin/gdext that referenced this issue Jul 27, 2024
@Yarwin
godot-rust#810 Docs comments do not show up if only some of the class…
f67c934 
… members/methods are documented

- Don't generate empty block if given declarations are not present
Yarwin added a commit to Yarwin/gdext that referenced this issue Jul 27, 2024
@Yarwin
godot-rust#810 Docs comments do not show up if only some of the class…
1d83966 
… members/methods are documented

- Document `block_docstring_or_empty` function
Yarwin added a commit to Yarwin/gdext that referenced this issue Jul 27, 2024
@Yarwin
godot-rust#810 Docs comments do not show up if only some of the class…
d4ab863 
… members/methods are documented

- Generate documentation blocks for signals & constants in compile time and keep them as &'static str
- InherentImplDocs is no longer kept as an Option
Yarwin added a commit to Yarwin/gdext that referenced this issue Jul 27, 2024
@Yarwin
godot-rust#810 Docs comments do not show up if only some of the class…
ddbeb75 
… members/methods are documented

- Implement post-review code tweaks.
Yarwin added a commit to Yarwin/gdext that referenced this issue Jul 27, 2024
@Yarwin
godot-rust#810 Docs comments do not show up if only some of the class…
4ff001e 
… members/methods are documented

- Extend docs test case to feature some undocumented members of godot instances
- Change map&unwrap in docs.rs to filter_map (allow to document only subset of all the properties of a given class)
- Generate documentation blocks for signals & constants on compile-time
Yarwin added a commit to Yarwin/gdext that referenced this issue Jul 27, 2024
@Yarwin
godot-rust#810 Docs comments do not show up if only some of the class…
1ba8157 
… members/methods are documented

- Extend docs test case to feature some undocumented members of godot instances
- Change map&unwrap in docs.rs to filter_map (allow to document only subset of all the properties of a given class)
- Generate documentation blocks for signals & constants on compile-time
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug c: register Register classes, functions and other symbols to GDScript
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix doc comments not showing up if only some class members are documented Yarwin/gdext
2 participants
@Bromeon @RedMser