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

docs: javadocs are now consistent with code, issue #4120 is now fixed. #10762

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

DanielSEncora
Copy link

Prepare


Description

Target issue

Fixing issue #4120 #4120

closes #4120


Test and Document the changes

  • Static code analysis has been run locally and issues have been fixed
  • Relevant unit and integration tests have been added/updated
  • Relevant documentation has been updated if any (i.e. user guides, installation and configuration guides, technical design docs etc)

Please check the below before submitting your PR. The PR will not be merged if there are no commits that start with docs: to indicate documentation changes or if the below checklist is not selected.

  • [ x] I confirm that there is no impact on the docs due to the code changes in this PR.

@DanielSEncora DanielSEncora force-pushed the jans-auth-server-docFixBranch branch from a1f0969 to 421431e Compare January 30, 2025 03:20
@@ -499,7 +499,7 @@
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<failOnError>false</failOnError>
<!-- <failOnError>false</failOnError> -->
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there any reason to comment this line? We don't want to fail build due to javadoc.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @yuriyz, since the steps to reproduce the issue #4120 were the ones below:

  1. Find and comment out false configuration for javadoc plug-in across module pom files
    2.Now run mvn javadoc:javadoc for each module one-by-one"

Once I fixed the documentation inconsistencies I noticed that the application did not fail to build anymore, therefore, I thought that having "false" to counter the build fail was no longer necessary.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Understood. This has to be configurable via variable and jenkins job can be configured appropriately. We can't simply enable it and force fail for each and every build.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done! Comment has been removed to avoid fail build in my last commit. @yuriyz

@DanielSEncora DanielSEncora force-pushed the jans-auth-server-docFixBranch branch from 5f0b979 to 048e34b Compare January 30, 2025 17:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

fix(docs): javadoc comments are inconsistent with code
2 participants