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

Error in Readme doc for Json binding and others #525

Open
turkeylurkey opened this issue May 28, 2024 · 0 comments
Open

Error in Readme doc for Json binding and others #525

turkeylurkey opened this issue May 28, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@turkeylurkey
Copy link
Contributor

turkeylurkey commented May 28, 2024

On line 130 of README.md it says "When an accessor is annotated with @JsonbTransient, its field or the accessor must not be annotated with other JSON Binding annotations. | Error | Remove @JsonbTransient OR Remove @JsonbProperty/@JsonbAnnotation" It is my understanding that there are no quick fixes for accessors that use @JsonbTransient so the docs should be updated (references to quick fixes removed).

On line 117 of README.md it says "The @Inject annotation must not define a final method." According to the second column the word "method" in this snippet should be "field."

In the table starting on line 201 there should be entries for these diagnostics

  • "Annotated classes with @WebFilter must implement the Filter interface." (error) and a quick fix "Let 'class_name' extend 'Filter'".
  • Annotated classes with @WebListener must implement one or more of the following interfaces: ServletContextListener, ServletContextAttributeListener, ServletRequestListener, ServletRequestAttributeListener, HttpSessionListener, HttpSessionAttributeListener, or HttpSessionIdListener. (error) and seven quick fixes, one for each of the 7 interfaces listed in the diagnostic.
  • The annotation @WebFilter can not have both 'value' and 'urlPatterns' attributes specified at once. (Error) Two quick fixes "Remove the ‘urlPatterns’ attribute from @WebFilter. Remove the ‘value’ attribute from @WebFilter."
  • The @WebServlet annotation cannot have both 'value' and 'urlPatterns' attributes specified at once. (Error) Quick fixes: "Remove the ‘urlPatterns’ attribute from @WebServlet. OR Remove the ‘value’ attribute from @WebServlet."
  • The annotation @WebFilter must define the attribute 'urlPatterns', 'servletNames' or 'value' (Error) Quick fixes: "Add the 'value' attribute to @WebFilter OR Add the 'urlPatterns' attribute to @WebFilter OR Add the 'servletNames' attribute to @WebFilter"
@turkeylurkey turkeylurkey added the documentation Improvements or additions to documentation label May 28, 2024
@turkeylurkey turkeylurkey changed the title Error in Readme doc for Json binding quick fixes Error in Readme doc for Json binding and Dependency Injection May 28, 2024
@turkeylurkey turkeylurkey changed the title Error in Readme doc for Json binding and Dependency Injection Error in Readme doc for Json binding and others May 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant