com.exadatum.xsuite.xmaven.bash.doc.DocGenerator 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.

The newest version!

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.IOException;

/**
 * Contract for Documentation generator. {@link DocGeneratorContext} contains
 * information about the template file, output file and the parsed document
 * block objects to be used in generation.
 */
public interface DocGenerator {

  /**
   * Generate documentation.
   *
   * @param context
   *          {@link DocGeneratorContext} contains information about the
   *          template file, output file and the parsed document block objects
   *          to be used in generation.
   * @throws IOException
   *           IOException
   */
  void generate(DocGeneratorContext context) throws IOException;

}