You are viewing a plain text version of this content. The canonical link for it is here.

Posted to dev@sling.apache.org by "bkkothari2255 (via GitHub)" <gi...@apache.org> on 2026/10/06 20:24:01 UTC

[PR] SLING-13377 Fix Javadoc [sling-org-apache-sling-engine]

bkkothari2255 opened a new pull request, #103:
URL: https://github.com/apache/sling-org-apache-sling-engine/pull/103

   Issue : SLING-13377
   
   - resolving all 9 Javadoc warnings reported during the Maven build (`javadoc:javadoc`) for `org.apache.sling.engine`:
   1. **Package-level Javadocs**: 
   - Added missing Javadoc comments to package-info files for:
      - `org.apache.sling.engine`
      - `org.apache.sling.engine.jmx`
      - `org.apache.sling.engine.servlets`
      
   2. **Method Javadocs**: 
   - Added missing Javadoc comments to public methods in `AbstractServiceReferenceConfig`:
      - `getInitParameter(String)`
      - `getInitParameterNames()`
      - `getServletContext()`
      
   3. **Default Constructor Warnings**:
   - Added private constructors to utility/constants classes to prevent default constructor generation and instantiation:
      - `EngineConstants`
      - `RequestUtil`
      - `ResponseUtil`
    
   ### Verification
   - `mvn clean javadoc:javadoc` succeeds with **0 warnings**.
   - `mvn spotless:check` passes cleanly.
   - `mvn clean test` passes all 137 unit tests.
   


-- 
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@sling.apache.org

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

Re: [PR] SLING-13377 Fix Javadoc [sling-org-apache-sling-engine]

Posted by "sonarqubecloud[bot] (via GitHub)" <gi...@apache.org>.

sonarqubecloud[bot] commented on PR #103:
URL: https://github.com/apache/sling-org-apache-sling-engine/pull/103#issuecomment-6033930815

   ## [![Quality Gate Failed](https://sonarsource.github.io/sonarcloud-github-static-resources/v2/checks/QualityGateBadge/qg-failed-20px.png 'Quality Gate Failed')](https://sonarcloud.io/dashboard?id=apache_sling-org-apache-sling-engine&pullRequest=103) **Quality Gate failed**  
   Failed conditions  
   ![](https://sonarsource.github.io/sonarcloud-github-static-resources/v2/common/failed-16px.png '') [0.0% Coverage on New Code](https://sonarcloud.io/component_measures?id=apache_sling-org-apache-sling-engine&pullRequest=103&metric=new_coverage&view=list) (required ≥ 80%)  
   ![](https://sonarsource.github.io/sonarcloud-github-static-resources/v2/common/failed-16px.png '') [D Maintainability Rating on New Code](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-engine&pullRequest=103&issueStatuses=OPEN,CONFIRMED&sinceLeakPeriod=true) (required ≥ A)  
     
   <!-- sqra:qg_revision=153c455fed7a1bfb7092574223eef1b9a3c833a41caa34da86f295ed340aa1ac -->
   <!-- sqra-placement-anchor -->
   [See analysis details on SonarQube Cloud](https://sonarcloud.io/dashboard?id=apache_sling-org-apache-sling-engine&pullRequest=103)
   
   ##   
   ![](https://sonarsource.github.io/sonarcloud-github-static-resources/v2/common/light_bulb-16px.png '') Catch issues before they fail your Quality Gate with our IDE extension ![](https://sonarsource.github.io/sonarcloud-github-static-resources/v2/common/sonarlint-16px.png '') [SonarQube for IDE](https://www.sonarsource.com/products/sonarlint/features/connected-mode/?referrer=pull-request)
   
   


-- 
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@sling.apache.org

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

Re: [PR] SLING-13377 Fix Javadoc [sling-org-apache-sling-engine]

Posted by "bkkothari2255 (via GitHub)" <gi...@apache.org>.

bkkothari2255 commented on PR #103:
URL: https://github.com/apache/sling-org-apache-sling-engine/pull/103#issuecomment-6044114022

   > I don' think that these unit tests added here have any value, can you please remove them?
   
   I initially added those unit tests because Sonar flagged the new explicit constructors for 0% code coverage on new code and failed the PR Quality Gate check
   
   However, I completely agree with your point that tests like assertNotNull(new UtilityClass()) don't provide real behavioural testing value. I have removed those unit tests in the latest commit


-- 
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@sling.apache.org

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

Re: [PR] SLING-13377 Fix Javadoc [sling-org-apache-sling-engine]

Posted by "joerghoh (via GitHub)" <gi...@apache.org>.

joerghoh commented on PR #103:
URL: https://github.com/apache/sling-org-apache-sling-engine/pull/103#issuecomment-6035543022

   I don' think that these unit tests added here have any value, can you please remove them?


-- 
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@sling.apache.org

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

Re: [PR] SLING-13377 Fix Javadoc [sling-org-apache-sling-engine]

Posted by "sonarqubecloud[bot] (via GitHub)" <gi...@apache.org>.

sonarqubecloud[bot] commented on PR #103:
URL: https://github.com/apache/sling-org-apache-sling-engine/pull/103#issuecomment-6044087406

   ## [![Quality Gate Failed](https://sonarsource.github.io/sonarcloud-github-static-resources/v2/checks/QualityGateBadge/qg-failed-20px.png 'Quality Gate Failed')](https://sonarcloud.io/dashboard?id=apache_sling-org-apache-sling-engine&pullRequest=103) **Quality Gate failed**  
   Failed conditions  
   ![](https://sonarsource.github.io/sonarcloud-github-static-resources/v2/common/failed-16px.png '') [0.0% Coverage on New Code](https://sonarcloud.io/component_measures?id=apache_sling-org-apache-sling-engine&pullRequest=103&metric=new_coverage&view=list) (required ≥ 80%)  
     
   <!-- sqra:qg_revision=c7a35131908b25b6eabb3a99d97e882e9d39e1f10190073ac07e9bb46033865d -->
   <!-- sqra-placement-anchor -->
   [See analysis details on SonarQube Cloud](https://sonarcloud.io/dashboard?id=apache_sling-org-apache-sling-engine&pullRequest=103)
   
   


-- 
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@sling.apache.org

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

Re: [PR] SLING-13377 Fix Javadoc [sling-org-apache-sling-engine]

Posted by "sonarqubecloud[bot] (via GitHub)" <gi...@apache.org>.

sonarqubecloud[bot] commented on PR #103:
URL: https://github.com/apache/sling-org-apache-sling-engine/pull/103#issuecomment-6034360245

   ## [![Quality Gate Failed](https://sonarsource.github.io/sonarcloud-github-static-resources/v2/checks/QualityGateBadge/qg-failed-20px.png 'Quality Gate Failed')](https://sonarcloud.io/dashboard?id=apache_sling-org-apache-sling-engine&pullRequest=103) **Quality Gate failed**  
   Failed conditions  
   ![](https://sonarsource.github.io/sonarcloud-github-static-resources/v2/common/failed-16px.png '') [B Maintainability Rating on New Code](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-engine&pullRequest=103&issueStatuses=OPEN,CONFIRMED&sinceLeakPeriod=true) (required ≥ A)  
     
   <!-- sqra:qg_revision=31a52c6ed834b78337e8fb6ec662e74ebd706993c63ac86d2d250d92b7036681 -->
   <!-- sqra-placement-anchor -->
   [See analysis details on SonarQube Cloud](https://sonarcloud.io/dashboard?id=apache_sling-org-apache-sling-engine&pullRequest=103)
   
   ##   
   ![](https://sonarsource.github.io/sonarcloud-github-static-resources/v2/common/light_bulb-16px.png '') Catch issues before they fail your Quality Gate with our IDE extension ![](https://sonarsource.github.io/sonarcloud-github-static-resources/v2/common/sonarlint-16px.png '') [SonarQube for IDE](https://www.sonarsource.com/products/sonarlint/features/connected-mode/?referrer=pull-request)
   
   


-- 
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@sling.apache.org

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

Re: [PR] SLING-13377 Fix Javadoc [sling-org-apache-sling-engine]

Posted by "bkkothari2255 (via GitHub)" <gi...@apache.org>.

bkkothari2255 commented on PR #103:
URL: https://github.com/apache/sling-org-apache-sling-engine/pull/103#issuecomment-6044210324

   Thanks @cziegeler! All points from the review have been addressed in the latest commit


-- 
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@sling.apache.org

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

Re: [PR] SLING-13377 Fix Javadoc [sling-org-apache-sling-engine]

Posted by "joerghoh (via GitHub)" <gi...@apache.org>.

joerghoh commented on PR #103:
URL: https://github.com/apache/sling-org-apache-sling-engine/pull/103#issuecomment-6061192710

   thanks @bkkothari2255 for your contribution, I merged it.


-- 
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@sling.apache.org

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

Re: [PR] SLING-13377 Fix Javadoc [sling-org-apache-sling-engine]

Posted by "joerghoh (via GitHub)" <gi...@apache.org>.

joerghoh merged PR #103:
URL: https://github.com/apache/sling-org-apache-sling-engine/pull/103


-- 
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@sling.apache.org

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