Exclude documentation examples from main API Javadoc

pull/11597/merge
Andy Wilkinson 7 years ago
parent 5522174e96
commit 7b32cf82df

@ -907,6 +907,7 @@
<dependencySourceIncludes> <dependencySourceIncludes>
<dependencySourceInclude>${project.groupId}:*</dependencySourceInclude> <dependencySourceInclude>${project.groupId}:*</dependencySourceInclude>
</dependencySourceIncludes> </dependencySourceIncludes>
<sourceFileExcludes>org/springframework/boot/docs/**/*.java</sourceFileExcludes>
<attach>false</attach> <attach>false</attach>
<quiet>true</quiet> <quiet>true</quiet>
<stylesheetfile>${basedir}/src/main/javadoc/spring-javadoc.css</stylesheetfile> <stylesheetfile>${basedir}/src/main/javadoc/spring-javadoc.css</stylesheetfile>

@ -61,8 +61,8 @@ Phillip Webb; Dave Syer; Josh Long; Stéphane Nicoll; Rob Winch; Andy Wilkinson;
:gradle-userguide: https://www.gradle.org/docs/current/userguide :gradle-userguide: https://www.gradle.org/docs/current/userguide
:propdeps-plugin: https://github.com/spring-projects/gradle-plugins/tree/master/propdeps-plugin :propdeps-plugin: https://github.com/spring-projects/gradle-plugins/tree/master/propdeps-plugin
:ant-manual: http://ant.apache.org/manual :ant-manual: http://ant.apache.org/manual
:code-examples: ../java/org/springframework/boot :code-examples: ../java/org/springframework/boot/docs
:test-examples: ../../test/java/org/springframework/boot :test-examples: ../../test/java/org/springframework/boot/docs
:gradle-user-guide: https://docs.gradle.org/4.2.1/userguide :gradle-user-guide: https://docs.gradle.org/4.2.1/userguide
:hibernate-documentation: https://docs.jboss.org/hibernate/orm/5.2/userguide/html_single/Hibernate_User_Guide.html :hibernate-documentation: https://docs.jboss.org/hibernate/orm/5.2/userguide/html_single/Hibernate_User_Guide.html
:jetty-documentation: https://www.eclipse.org/jetty/documentation/9.4.x :jetty-documentation: https://www.eclipse.org/jetty/documentation/9.4.x

@ -14,8 +14,10 @@
* limitations under the License. * limitations under the License.
*/ */
package org.springframework.boot; package org.springframework.boot.docs;
import org.springframework.boot.ExitCodeGenerator;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Bean;

@ -14,7 +14,7 @@
* limitations under the License. * limitations under the License.
*/ */
package org.springframework.boot.actuate.metrics; package org.springframework.boot.docs.actuate.metrics;
import io.micrometer.core.instrument.config.MeterFilter; import io.micrometer.core.instrument.config.MeterFilter;

@ -14,7 +14,7 @@
* limitations under the License. * limitations under the License.
*/ */
package org.springframework.boot.autoconfigure; package org.springframework.boot.docs.autoconfigure;
/** /**
* Sample service. * Sample service.

@ -14,13 +14,13 @@
* limitations under the License. * limitations under the License.
*/ */
package org.springframework.boot.autoconfigure; package org.springframework.boot.docs.autoconfigure;
import org.springframework.boot.autoconfigure.UserServiceAutoConfiguration.UserProperties;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.EnableConfigurationProperties; import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.boot.docs.autoconfigure.UserServiceAutoConfiguration.UserProperties;
import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Configuration;

@ -14,9 +14,10 @@
* limitations under the License. * limitations under the License.
*/ */
package org.springframework.boot.builder; package org.springframework.boot.docs.builder;
import org.springframework.boot.Banner; import org.springframework.boot.Banner;
import org.springframework.boot.builder.SpringApplicationBuilder;
/** /**
* Examples of using {@link SpringApplicationBuilder}. * Examples of using {@link SpringApplicationBuilder}.

@ -14,7 +14,7 @@
* limitations under the License. * limitations under the License.
*/ */
package org.springframework.boot.cloudfoundry; package org.springframework.boot.docs.cloudfoundry;
import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.builders.HttpSecurity; import org.springframework.security.config.annotation.web.builders.HttpSecurity;

@ -14,7 +14,7 @@
* limitations under the License. * limitations under the License.
*/ */
package org.springframework.boot.context; package org.springframework.boot.docs.context;
import java.io.IOException; import java.io.IOException;

@ -14,7 +14,7 @@
* limitations under the License. * limitations under the License.
*/ */
package org.springframework.boot.context.embedded; package org.springframework.boot.docs.context.embedded;
import org.apache.tomcat.util.http.LegacyCookieProcessor; import org.apache.tomcat.util.http.LegacyCookieProcessor;

@ -14,7 +14,7 @@
* limitations under the License. * limitations under the License.
*/ */
package org.springframework.boot.elasticsearch; package org.springframework.boot.docs.elasticsearch;
import javax.persistence.EntityManagerFactory; import javax.persistence.EntityManagerFactory;

@ -14,7 +14,7 @@
* limitations under the License. * limitations under the License.
*/ */
package org.springframework.boot.elasticsearch.jest; package org.springframework.boot.docs.elasticsearch.jest;
import io.searchbox.client.config.HttpClientConfig; import io.searchbox.client.config.HttpClientConfig;

@ -14,11 +14,12 @@
* limitations under the License. * limitations under the License.
*/ */
package org.springframework.boot.jdbc; package org.springframework.boot.docs.jdbc;
import javax.sql.DataSource; import javax.sql.DataSource;
import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.jdbc.DataSourceBuilder;
import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Configuration;

@ -14,7 +14,7 @@
* limitations under the License. * limitations under the License.
*/ */
package org.springframework.boot.jdbc; package org.springframework.boot.docs.jdbc;
import javax.sql.DataSource; import javax.sql.DataSource;

@ -14,7 +14,7 @@
* limitations under the License. * limitations under the License.
*/ */
package org.springframework.boot.jdbc; package org.springframework.boot.docs.jdbc;
import javax.sql.DataSource; import javax.sql.DataSource;

@ -14,13 +14,14 @@
* limitations under the License. * limitations under the License.
*/ */
package org.springframework.boot.jdbc; package org.springframework.boot.docs.jdbc;
import javax.sql.DataSource; import javax.sql.DataSource;
import com.zaxxer.hikari.HikariDataSource; import com.zaxxer.hikari.HikariDataSource;
import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.jdbc.DataSourceBuilder;
import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Configuration;

@ -14,7 +14,7 @@
* limitations under the License. * limitations under the License.
*/ */
package org.springframework.boot.jdbc; package org.springframework.boot.docs.jdbc;
import javax.sql.DataSource; import javax.sql.DataSource;
@ -22,6 +22,7 @@ import org.apache.commons.dbcp2.BasicDataSource;
import org.springframework.boot.autoconfigure.jdbc.DataSourceProperties; import org.springframework.boot.autoconfigure.jdbc.DataSourceProperties;
import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.jdbc.DataSourceBuilder;
import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Primary; import org.springframework.context.annotation.Primary;

@ -14,7 +14,7 @@
* limitations under the License. * limitations under the License.
*/ */
package org.springframework.boot.test.autoconfigure.restdocs.restassured; package org.springframework.boot.docs.test.autoconfigure.restdocs.restassured;
import org.springframework.boot.test.autoconfigure.restdocs.RestDocsRestAssuredConfigurationCustomizer; import org.springframework.boot.test.autoconfigure.restdocs.RestDocsRestAssuredConfigurationCustomizer;
import org.springframework.boot.test.context.TestConfiguration; import org.springframework.boot.test.context.TestConfiguration;

@ -14,7 +14,7 @@
* limitations under the License. * limitations under the License.
*/ */
package org.springframework.boot.test.autoconfigure.restdocs.restassured; package org.springframework.boot.docs.test.autoconfigure.restdocs.restassured;
// tag::source[] // tag::source[]
import io.restassured.specification.RequestSpecification; import io.restassured.specification.RequestSpecification;

@ -14,7 +14,7 @@
* limitations under the License. * limitations under the License.
*/ */
package org.springframework.boot.test.spock; package org.springframework.boot.docs.test.spock;
import org.springframework.beans.factory.ObjectProvider; import org.springframework.beans.factory.ObjectProvider;
import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.test.context.SpringBootTest;

@ -14,7 +14,7 @@
* limitations under the License. * limitations under the License.
*/ */
package org.springframework.boot.test.web; package org.springframework.boot.docs.test.web;
// tag::test-random-port[] // tag::test-random-port[]
import org.junit.Test; import org.junit.Test;

@ -14,7 +14,7 @@
* limitations under the License. * limitations under the License.
*/ */
package org.springframework.boot.test.web; package org.springframework.boot.docs.test.web;
// tag::test-random-port[] // tag::test-random-port[]

@ -14,7 +14,7 @@
* limitations under the License. * limitations under the License.
*/ */
package org.springframework.boot.web.client; package org.springframework.boot.docs.web.client;
import org.apache.http.HttpException; import org.apache.http.HttpException;
import org.apache.http.HttpHost; import org.apache.http.HttpHost;
@ -24,6 +24,7 @@ import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.impl.conn.DefaultProxyRoutePlanner; import org.apache.http.impl.conn.DefaultProxyRoutePlanner;
import org.apache.http.protocol.HttpContext; import org.apache.http.protocol.HttpContext;
import org.springframework.boot.web.client.RestTemplateCustomizer;
import org.springframework.http.client.HttpComponentsClientHttpRequestFactory; import org.springframework.http.client.HttpComponentsClientHttpRequestFactory;
import org.springframework.web.client.RestTemplate; import org.springframework.web.client.RestTemplate;

@ -14,7 +14,7 @@
* limitations under the License. * limitations under the License.
*/ */
package org.springframework.boot.web.security; package org.springframework.boot.docs.web.security;
import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.builders.HttpSecurity; import org.springframework.security.config.annotation.web.builders.HttpSecurity;

@ -14,10 +14,11 @@
* limitations under the License. * limitations under the License.
*/ */
package org.springframework.boot.autoconfigure; package org.springframework.boot.docs.autoconfigure;
import org.junit.Test; import org.junit.Test;
import org.springframework.boot.autoconfigure.AutoConfigurations;
import org.springframework.boot.test.context.FilteredClassLoader; import org.springframework.boot.test.context.FilteredClassLoader;
import org.springframework.boot.test.context.runner.ApplicationContextRunner; import org.springframework.boot.test.context.runner.ApplicationContextRunner;
import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Bean;

@ -14,7 +14,7 @@
* limitations under the License. * limitations under the License.
*/ */
package org.springframework.boot.builder; package org.springframework.boot.docs.builder;
import org.junit.Rule; import org.junit.Rule;
import org.junit.Test; import org.junit.Test;

@ -14,7 +14,7 @@
* limitations under the License. * limitations under the License.
*/ */
package org.springframework.boot.context; package org.springframework.boot.docs.context;
import org.junit.Test; import org.junit.Test;

@ -14,14 +14,14 @@
* limitations under the License. * limitations under the License.
*/ */
package org.springframework.boot.context.embedded; package org.springframework.boot.docs.context.embedded;
import org.apache.catalina.Context; import org.apache.catalina.Context;
import org.apache.tomcat.util.http.LegacyCookieProcessor; import org.apache.tomcat.util.http.LegacyCookieProcessor;
import org.junit.Test; import org.junit.Test;
import org.springframework.boot.SpringApplication; import org.springframework.boot.SpringApplication;
import org.springframework.boot.context.embedded.TomcatLegacyCookieProcessorExample.LegacyCookieProcessorConfiguration; import org.springframework.boot.docs.context.embedded.TomcatLegacyCookieProcessorExample.LegacyCookieProcessorConfiguration;
import org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory; import org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory;
import org.springframework.boot.web.embedded.tomcat.TomcatWebServer; import org.springframework.boot.web.embedded.tomcat.TomcatWebServer;
import org.springframework.boot.web.server.WebServerFactoryCustomizerBeanPostProcessor; import org.springframework.boot.web.server.WebServerFactoryCustomizerBeanPostProcessor;

@ -14,7 +14,7 @@
* limitations under the License. * limitations under the License.
*/ */
package org.springframework.boot.jdbc; package org.springframework.boot.docs.jdbc;
import java.sql.SQLException; import java.sql.SQLException;

@ -14,7 +14,7 @@
* limitations under the License. * limitations under the License.
*/ */
package org.springframework.boot.jdbc; package org.springframework.boot.docs.jdbc;
import java.sql.SQLException; import java.sql.SQLException;

@ -14,7 +14,7 @@
* limitations under the License. * limitations under the License.
*/ */
package org.springframework.boot.jdbc; package org.springframework.boot.docs.jdbc;
import java.sql.SQLException; import java.sql.SQLException;

@ -14,7 +14,7 @@
* limitations under the License. * limitations under the License.
*/ */
package org.springframework.boot.jdbc; package org.springframework.boot.docs.jdbc;
import javax.sql.DataSource; import javax.sql.DataSource;

@ -14,7 +14,7 @@
* limitations under the License. * limitations under the License.
*/ */
package org.springframework.boot.jdbc; package org.springframework.boot.docs.jdbc;
import java.sql.SQLException; import java.sql.SQLException;

@ -14,7 +14,7 @@
* limitations under the License. * limitations under the License.
*/ */
package org.springframework.boot.jdbc; package org.springframework.boot.docs.jdbc;
import java.sql.SQLException; import java.sql.SQLException;

@ -14,7 +14,7 @@
* limitations under the License. * limitations under the License.
*/ */
package org.springframework.boot.test.spock; package org.springframework.boot.docs.test.spock;
import org.junit.Test; import org.junit.Test;
import org.junit.runner.RunWith; import org.junit.runner.RunWith;
Loading…
Cancel
Save