/**
 *
 *    Copyright 2018-2022 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 com.github.chhorz.javadoc.replacements;

/**
 * Interface for custom replacements.
 *
 * @author chhorz
 */
public interface Replacement {

	/**
	 * Action that performs a replacement on a javadoc string.
	 *
	 * @param input the javadoc input string
	 * @return the javadoc string after the replacement
	 */
	String perform(String input);

}
