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

Fix javadoc for tagsdoc #216

Merged
merged 2 commits into from
Feb 23, 2022
Merged

Conversation

volosied
Copy link
Contributor

@volosied volosied commented Feb 22, 2022

workaround for #215

  • Skipping majority of the errors via doclint
  • Fixing a few necessary errors
  • Skipped tagdoc javadoc jar since I don't believe we need it published?

@volosied volosied requested a review from pnicolucci February 22, 2022 16:44
@volosied volosied self-assigned this Feb 22, 2022
@volosied volosied changed the title Fix javadoc for tagsdoc & Update pom Fix javadoc for tagsdoc Feb 22, 2022
Copy link
Contributor

@pnicolucci pnicolucci left a comment

Choose a reason for hiding this comment

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

A couple of comments:

  1. Can you update the tagsdoc/pom.xml copyright header to use the two date format like we've been using in the project for consistency?
  2. Should we add the eclipse copyright to the files you modified for the javadocs?
  3. It looks like we publish the javadoc for the IMPL so why not publish it for the tagsdoc? I don't have a strong opinion one way or another. I guess skipping it makes sense because no one else will be using this as it is specific for the Jakarta Tags implementation just wanted to see if you had the same thoughts.

@volosied
Copy link
Contributor Author

1 & 2 -- Added. Let me know if ParseException.java looks ok? it's a generated file, so it doens't have any existing copyright.

  1. I don't think we should publish this as this component is just for us. I don't even see the original with javadoc files: https://repo1.maven.org/maven2/taglibrarydoc/tlddoc/1.3/

@pnicolucci
Copy link
Contributor

1 & 2 -- Added. Let me know if ParseException.java looks ok? it's a generated file, so it doens't have any existing copyright.

3. I don't think we should publish this as this component is just for us.   I don't even see the original with javadoc files: https://repo1.maven.org/maven2/taglibrarydoc/tlddoc/1.3/

If there wasn't a copyright to begin with on a generated class I think we're ok to just leave it be.

@volosied volosied force-pushed the 215-fix-tagdoc-javadoc branch from 6fb6c7d to 8836dbe Compare February 23, 2022 15:57
@volosied volosied force-pushed the 215-fix-tagdoc-javadoc branch from 8836dbe to a2a0337 Compare February 23, 2022 17:47
@volosied volosied merged commit a414f37 into jakartaee:master Feb 23, 2022
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.

2 participants