We have identified possible instances of outdated documentation and suggest the updates, as follows:



  1. org.springframework.boot.web.servlet.server.DefaultServlet was deleted but the change has not been reflected in the current version of the how to guide at https://github.com/spring-projects/spring-boot/blob/main/spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/spring-mvc.adoc

Outdated Text:

  • An javadoc:org.springframework.web.servlet.view.InternalResourceViewResolver[] named 'defaultViewResolver'. This one locates physical resources that can be rendered by using the DefaultServlet (including static resources and JSP pages, if you use those).

Proposed Update:

  • An javadoc:org.springframework.web.servlet.view.InternalResourceViewResolver[] named 'defaultViewResolver'. This resolver locates physical resources that can be rendered, such as static resources and JSP pages (if applicable).
  1. org.springframework.boot.SpringApplication.setWebApplicationType(WebApplicationType) was deleted but the change has not been reflected in the current version of the how to guide at https://github.com/spring-projects/spring-boot/blob/main/spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/application.adoc

Outdated Text:

If you cannot do that (for example, if you run two applications from the same code base) then you can explicitly call setWebApplicationType(WebApplicationType.NONE) on your javadoc:org.springframework.boot.SpringApplication[] instance or set the applicationContextClass property (through the Java API or with external properties).

Proposed Update:

If you cannot do that (for example, if you run two applications from the same code base) then you can configure the application explicitly to indicate that it is not a web application. Use the spring.main.web-application-type=none property in your application.properties or application.yml file to achieve this. This property replaces the deprecated setWebApplicationType(WebApplicationType.NONE) method.

About: This is part of a research project that aims to automatically identify outdated API references in documentation in GitHub repositories and update them. We welcome any feedback. Thanks!

Comment From: snicoll

@saleese did you check the output of the tool before creating the issue?

org.springframework.boot.web.servlet.server.DefaultServlet was deleted but the change has not been reflected in the current version of the how to guide

I don't know what that class is. I don't remember we ever had such a class.

org.springframework.boot.SpringApplication.setWebApplicationType(WebApplicationType) was deleted

It wasn't.

We're a small team, please be considerate of our time before submitting the output of an automated tool.

Comment From: saleese

Thank you for your feedback. I will be careful to report the output of the automated tool. I will check twice more before reporting them.

Regarding the DefaultServlet is specified in the doc. However, I found that I mislinked the associated doc at the first reporting time, and revised the link. If you have time, please, check it. If it is so trivial and you do not need to check it, please ignore my reponse.