yesamer opened a new issue, #7064:
URL: https://github.com/apache/incubator-kie/issues/7064

   Restore and improve kie-api Javadoc generation and API compatibility 
reporting. Ensure the module publishes its Javadoc jar during regular builds, 
refresh core API documentation for JDK 17+ era usage, and reintroduce 
compatibility verification with RevAPI and JApiCmp. Also document 
long-deprecated APIs more precisely by adding explicit since / forRemoval 
metadata, while configuring RevAPI to treat these annotation enrichments as 
non-breaking documentation updates.
   
   Objectives
   
   - Ensure kie-api generates and publishes its Javadoc jar during standard 
builds
   - Refresh and improve Javadoc content for key public API types and the main 
Javadoc overview page
   - Clarify existing deprecated APIs with richer Javadoc and explicit since / 
forRemoval metadata
   - Re-enable API compatibility checks for kie-api using RevAPI during verify
   - Configure RevAPI to ignore documentation-only changes related to enriching 
existing @Deprecated annotations
   - Configure JApiCmp reporting for kie-api to compare released and current 
API versions
   - Keep compatibility analysis focused on public API by excluding internal 
packages from reporting


-- 
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: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to