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

Annotation of Consumer/Provider Type #701

Open
PengZheng opened this issue Dec 15, 2023 · 1 comment
Open

Annotation of Consumer/Provider Type #701

PengZheng opened this issue Dec 15, 2023 · 1 comment
Assignees
Labels
kind/documentation Categorizes issue or PR as related to documentation. kind/improvement Categorizes issue or PR as related to improvements.

Comments

@PengZheng
Copy link
Contributor

When looking at a Celix Service Interface for the first time, it is pretty easy to get confused as to whether you should implement and register the service in the header file or just track and use the service. Though we don't support annotation directly in C++, adding Doxygen comments such as @qualifer ProviderType or @qualifer ConsumerType should be enough to help our users.

Note that qualifer is a standard Doxygen command.
If users hover over the type documented this way in an IDE like CLion, the qualifier (ProviderType/ConsumerType) will appear in the generated documentation.

@PengZheng PengZheng self-assigned this Dec 15, 2023
@pnoltes
Copy link
Contributor

pnoltes commented Jan 2, 2024

This would be an welcome addition.

This could also have an impact on how we handle service versions bumps.
Currently if a service gets a additional function/method, this is treated as a major update for the service. But if the service is annotation as a provided type, a minor bump is enough, because from a user point of view the the service is provided and an additional function/method is not a breaking change.

@PengZheng PengZheng added kind/documentation Categorizes issue or PR as related to documentation. kind/improvement Categorizes issue or PR as related to improvements. labels Mar 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation. kind/improvement Categorizes issue or PR as related to improvements.
Projects
None yet
Development

No branches or pull requests

2 participants