[I] Annotation of Consumer/Provider Type (celix)

["PengZheng (via GitHub)" <gi...@apache.org>]

PengZheng opened a new issue, #701:
URL: https://github.com/apache/celix/issues/701

   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. 


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@celix.apache.org.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [I] Annotation of Consumer/Provider Type (celix)

["pnoltes (via GitHub)" <gi...@apache.org>]

pnoltes commented on issue #701:
URL: https://github.com/apache/celix/issues/701#issuecomment-1874387196

   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. 
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@celix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org