springfox.javadoc.configuration.JavadocPluginConfiguration Maven / Gradle / Ivy

Go to download
/*
 *
 *  Copyright 2018-2019 the original author or authors.
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *
 */
package springfox.javadoc.configuration;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;
import springfox.javadoc.doclet.SwaggerPropertiesDoclet;
import springfox.javadoc.plugin.JavadocBuilderPlugin;

/**
 * Spring configuration that adds the properties file generated by the {@link SwaggerPropertiesDoclet} as property
 * source and also adds the {@link JavadocBuilderPlugin} to the Spring context.
 * 
 * @author MartinNeumannBeTSE
 */
@Configuration
@PropertySource(value = "classpath:/"
  + SwaggerPropertiesDoclet.SPRINGFOX_JAVADOC_PROPERTIES, ignoreResourceNotFound = true)
@ComponentScan("springfox.javadoc.plugin")
public class JavadocPluginConfiguration {

    @Autowired
    JavadocBuilderPlugin javadocBuilderPlugin;

    @Bean
    public JavadocBuilderPlugin javadocBuilder() {
        return javadocBuilderPlugin;
    }
}