com.exadatum.xsuite.xmaven.bash.doc.DocBlockStructure 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%
 */

/**
 * Defines various components from the structure of document block
 *
 */
public enum DocBlockStructure {

	/**
	 * Constant to represent documentation block author annotation Name of the
	 * developer who wrote this code.
	 */
	AUTHOR("author"),

	/**
	 * Constant to represent documentation block version annotation. Version of
	 * this function
	 */
	VERSION("version"),

	/**
	 * Constant to represent documentation block since annotation. Ideally a
	 * date to represent when this function was added.
	 */
	SINCE("since"),

	/**
	 * Constant to represent documentation block category annotation. Something
	 * like java package to group functions together in documentation.
	 */
	CATAGORY("catagory"),

	/**
	 * Constant to represent documentation block param annotation. There can be
	 * more than one param annotations
	 */
	PARAM("param"),

	/**
	 * Constant to represent documentation block scope annotation. To mark if
	 * the function is public or private
	 */
	SCOPE("scope"),

	/**
	 * Constant to represent documentation block start tag
	 */
	START("#/**"),

	/**
	 * Constant to represent documentation block continuation tag
	 */
	CONTINUATION("#*"),

	/**
	 * Constant to represent documentation block end tag
	 */
	END("#*/");

	String keyword;

	DocBlockStructure(String keyword) {
		this.keyword = keyword;
	}

}