com.exadatum.xsuite.xmaven.bash.doc.DocGeneratorContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bash-maven-plugin Show documentation

Bash Maven Plugin is used to generate documentation as well as to run unit test for bash scripts.

There is a newer version: 1.0.7

package com.exadatum.xsuite.xmaven.bash.doc;

/*-
 * #%L
 * Exadatum Bash Function Document Generator
 * %%
 * Copyright (C) 2016 - 2017 Exadatum Software Services Pvt. Ltd.
 * %%
 * 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.
 * #L%
 */

import java.io.File;
import java.util.List;

/**
 * Context to hold all the information needed by documentation generator.
 *
 */
public class DocGeneratorContext {

	/**
	 * Page template to be used for document generation
	 */
	private File pageTemplate;

	/**
	 * Output page to be generated
	 */
	private File outputPage;

	/**
	 * Parsed documentation blocks
	 */
	private List docBlocks;

	public File getPageTemplate() {
		return pageTemplate;
	}

	public void setPageTemplate(File pageTemplate) {
		this.pageTemplate = pageTemplate;
	}

	public File getOutputPage() {
		return outputPage;
	}

	public void setOutputPage(File outputPage) {
		this.outputPage = outputPage;
	}

	public List getDocBlocks() {
		return docBlocks;
	}

	public void setDocBlocks(List docBlocks) {
		this.docBlocks = docBlocks;
	}

}