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

Consider allowing #[doc] in cxx_qt::inherit blocks #532

Closed
ahayzen-kdab opened this issue May 10, 2023 · 4 comments
Closed

Consider allowing #[doc] in cxx_qt::inherit blocks #532

ahayzen-kdab opened this issue May 10, 2023 · 4 comments
Assignees
Labels
📖 documentation Improvements or additions to documentation 🥳🎉 1.0 This issue is part of stabilization for 1.0 release

Comments

@ahayzen-kdab
Copy link
Collaborator

In #518 we start generating docs for any methods that are inherited, but instead we should consider if supporting passing through documentation instead and require the developer to document their inherit methods.

Currently if one tries to do this our generator states that the doc attribute is not supported.

@ahayzen-kdab ahayzen-kdab added 📖 documentation Improvements or additions to documentation 🙋 good first issue Good for newcomers 🤔 discussion Feedback welcome labels May 10, 2023
@ahayzen-kdab
Copy link
Collaborator Author

I think the problem with doing this will be that when the dev doesn't add the doc line and they have deny(missing_docs) enabled the error won't be obvious as it states that an associated function (one we generate in the macro) is missing the doc, not the original one from the inherit block.

@ahayzen-kdab
Copy link
Collaborator Author

We now allow passing through doc lines, but we should ensure that this is still the case after the new API with all the methods and types in the CXX blocks should be documented as usual.

@ahayzen-kdab ahayzen-kdab added 🥳🎉 1.0 This issue is part of stabilization for 1.0 release and removed 🙋 good first issue Good for newcomers 🤔 discussion Feedback welcome labels Jun 7, 2023
@ahayzen-kdab
Copy link
Collaborator Author

With #667 we pass through the original invokable and inherit methods which mean that the attributes are kept.

@LeonMatthesKDAB
Copy link
Collaborator

Done as of #1054

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 documentation Improvements or additions to documentation 🥳🎉 1.0 This issue is part of stabilization for 1.0 release
Projects
None yet
2 participants