apache / apache/celix

Annotation of Consumer/Provider Type

Open
#701 1 comment 0 reactions 1 assignee Claimed by @PengZheng View on GitHub
kind/documentation kind/improvement
Dominant language
C
Stars
193
Forks
99
Avg merge
1m
Merged PRs (30d)
1

Description

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](https://www.doxygen.nl/manual/commands.html#cmdqualifier) 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.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.